Партнерский API Маркета
API Яндекс Маркета помогает продавцам автоматизировать и упростить работу с маркетплейсом.
В числе возможностей интеграции:
-
управление каталогом товаров и витриной,
-
обработка заказов,
-
изменение настроек магазина,
-
получение отчетов.
Version: LATEST
BasePath:
BSD 3-Clause
https://opensource.org/license/bsd-3-clause/
Access
- OAuth AuthorizationUrl:https://oauth.yandex.ru/authorizeTokenUrl:
[ Jump to Models ]
Table of Contents
Up
post /businesses/{businessId}/bids/info
Информация об установленных ставках (getBidsInfoForBusiness)
Возвращает значения ставок для заданных товаров.
{% note warning "" %}
В ответе возвращаются значения только тех ставок, которые вы установили через запрос PUT businesses/{businessId}/bids. Получить информацию по кампаниям, созданным в кабинете, не получится.
{% endnote %}
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"bids" : [ {
"sku" : "sku",
"bid" : 570
}, {
"sku" : "sku",
"bid" : 570
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Значения ставок для заданных товаров. В ответ попадают только товары, на которые установлены ставки.
GetBidsInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/bids/recommendations
Рекомендованные ставки для заданных товаров (getBidsRecommendations)
Возвращает рекомендованные ставки для заданных товаров — такие ставки обеспечивают вашим предложениям определенную долю показов, если цена не превышает рекомендованную.
Для одного товара может возвращаться одна рекомендованная ставка или несколько. Во втором случае разные ставки предназначены для достижения разной доли показов.
Если товар только добавлен в каталог, но пока не продается, рекомендованной ставки для него не будет.
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"recommendations" : [ {
"bidRecommendations" : [ {
"showPercent" : 8,
"bid" : 570
}, {
"showPercent" : 8,
"bid" : 570
} ],
"priceRecommendations" : [ {
"campaignId" : 6,
"price" : 1.1465812980502945
}, {
"campaignId" : 6,
"price" : 1.1465812980502945
} ],
"sku" : "sku",
"bid" : 570
}, {
"bidRecommendations" : [ {
"showPercent" : 8,
"bid" : 570
}, {
"showPercent" : 8,
"bid" : 570
} ],
"priceRecommendations" : [ {
"campaignId" : 6,
"price" : 1.1465812980502945
}, {
"campaignId" : 6,
"price" : 1.1465812980502945
} ],
"sku" : "sku",
"bid" : 570
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Рекомендованные ставки для заданных товаров.
GetBidsRecommendationsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /businesses/{businessId}/bids
Включение буста продаж и установка ставок (putBidsForBusiness)
Запускает буст продаж — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.
{% cut "Как в кабинете выглядит кампания, созданная через API" %}
{% endcut %}
При первом использовании запроса Маркет: создаст единую на все магазины бизнес-аккаунта кампанию, добавит в нее товары с указанными ставками, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.
Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.
Запрос всегда работает с одной и той же созданной через API кампанией. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. Другими кампаниями управлять через API не получится. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.
Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.
Внести другие изменения в созданную через API кампанию можно в кабинете:
- выключить или включить кампанию;
- изменить ее название;
- выключить или включить ценовую стратегию.
Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.
Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.
{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}
𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.
{% endnote %}
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Все получилось: ставки установлены или обновлены. Если нужно, добавлены новые товары и запущена кампания.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/bids
Включение буста продаж и установка ставок для магазина (putBidsForCampaign)
Запускает буст продаж в указанном магазине — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.
При первом использовании запроса Маркет: создаст кампанию, добавит в нее товары с указанными ставками для заданного магазина, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.
Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.
Запрос всегда работает с одной и той же кампанией, созданной через этот запрос или PUT businesses/{businessId}/bids. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.
Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.
Внести другие изменения в созданную через API кампанию можно в кабинете:
- выключить или включить кампанию;
- изменить ее название;
- выключить или включить ценовую стратегию.
Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.
Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.
{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}
𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.
{% endnote %}
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/archive
Добавление товаров в архив (addOffersToArchive)
Помещает товары в архив. Товары, помещенные в архив, скрыты с витрины во всех магазинах кабинета.
{% note warning "В архив нельзя отправить товар, который хранится на складе Маркета" %}
Вначале такой товар нужно распродать или вывезти.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notArchivedOffers" : [ {
"offerId" : "offerId",
"error" : "OFFER_HAS_STOCKS"
}, {
"offerId" : "offerId",
"error" : "OFFER_HAS_STOCKS"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если некоторые товары добавить в архив не удалось, в ответе 200 будет их список.
Список успешно добавленных товаров не возвращается.
AddOffersToArchiveResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/delete
Удаление товаров из каталога (deleteOffers)
Удаляет товары из каталога.
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notDeletedOfferIds" : [ null, null ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине.
DeleteOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/unarchive
Удаление товаров из архива (deleteOffersFromArchive)
Восстанавливает товары из архива.
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notUnarchivedOfferIds" : [ null, null ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если некоторые товары восстановить из архива не удалось, в ответе 200 будет их список.
Список успешно восстановленных товаров не возвращается.
DeleteOffersFromArchiveResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings
Информация о товарах в каталоге (getOfferMappings)
Возвращает список товаров в каталоге, их категории на Маркете и характеристики каждого товара.
Можно использовать тремя способами:
- задать список интересующих SKU;
- задать фильтр — в этом случае результаты возвращаются постранично;
- не передавать тело запроса, чтобы получить список всех товаров в каталоге.
|⚙️ Лимит: 600 запросов в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
},
"offerMappings" : [ {
"offer" : {
"downloadable" : true,
"sellingPrograms" : [ {
"sellingProgram" : "FBY",
"status" : "FINE"
}, {
"sellingProgram" : "FBY",
"status" : "FINE"
} ],
"marketCategoryId" : 0,
"manufacturerCountries" : [ "Россия", "Россия" ],
"description" : "description",
"videos" : [ "videos", "videos", "videos", "videos", "videos" ],
"purchasePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"type" : "DEFAULT",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"archived" : true,
"campaigns" : [ {
"campaignId" : 9,
"status" : "PUBLISHED"
}, {
"campaignId" : 9,
"status" : "PUBLISHED"
} ],
"vendor" : "LEVENHUK",
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"barcodes" : [ "46012300000000", "46012300000000" ],
"params" : [ {
"name" : "Wi-Fi",
"value" : "есть"
}, {
"name" : "Wi-Fi",
"value" : "есть"
} ],
"tags" : [ "до 500 рублей", "до 500 рублей" ],
"condition" : {
"reason" : "reason",
"type" : "PREOWNED",
"quality" : "PERFECT"
},
"certificates" : [ "certificates", "certificates" ],
"boxCount" : 1,
"additionalExpenses" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"customsCommodityCode" : "8517610008",
"adult" : true,
"age" : {
"ageUnit" : "YEAR",
"value" : 0.5962133916683182
},
"manuals" : [ {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
} ]
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
}, {
"offer" : {
"downloadable" : true,
"sellingPrograms" : [ {
"sellingProgram" : "FBY",
"status" : "FINE"
}, {
"sellingProgram" : "FBY",
"status" : "FINE"
} ],
"marketCategoryId" : 0,
"manufacturerCountries" : [ "Россия", "Россия" ],
"description" : "description",
"videos" : [ "videos", "videos", "videos", "videos", "videos" ],
"purchasePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"type" : "DEFAULT",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"archived" : true,
"campaigns" : [ {
"campaignId" : 9,
"status" : "PUBLISHED"
}, {
"campaignId" : 9,
"status" : "PUBLISHED"
} ],
"vendor" : "LEVENHUK",
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"barcodes" : [ "46012300000000", "46012300000000" ],
"params" : [ {
"name" : "Wi-Fi",
"value" : "есть"
}, {
"name" : "Wi-Fi",
"value" : "есть"
} ],
"tags" : [ "до 500 рублей", "до 500 рублей" ],
"condition" : {
"reason" : "reason",
"type" : "PREOWNED",
"quality" : "PERFECT"
},
"certificates" : [ "certificates", "certificates" ],
"boxCount" : 1,
"additionalExpenses" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"customsCommodityCode" : "8517610008",
"adult" : true,
"age" : {
"ageUnit" : "YEAR",
"value" : 0.5962133916683182
},
"manuals" : [ {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
} ]
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о товарах в каталоге.
GetOfferMappingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/suggestions
Просмотр карточек на Маркете, которые подходят вашим товарам (getSuggestedOfferMappings)
Возвращает идентификаторы карточек на Маркете, которые соответствуют товарам с заданными параметрами.
Пользоваться этим запросом необязательно: он просто помогает заранее убедиться, что Маркет верно определяет карточки по предоставленным вами данным.
Как пользоваться запросом
- Передайте Маркету список товаров, которые нужно проверить.
- В ответ вы получите список SKU на Маркете с расшифровкой: названием, идентификатором модели, категорией.
- Если расшифровки мало, вы можете открыть карточку. Для этого перейдите по ссылке вида
https://market.yandex.ru/product/<marketModelId>?sku=<marketSku>.
- Если карточка соответствует товару, значит его можно добавлять в каталог с теми данными, что вы указали. Если карточка определилась неправильно — проверьте данные о товаре. Возможно, их нужно уточнить или дополнить. Кроме того, на этапе добавления товара вы можете указать
marketSKU, который ему подходит по вашему мнению.
{% note info "𝓠 Как определить marketSku товара, найденного на Маркете?" %}
𝓐 Он есть в адресе страницы товара — расположен после sku=.
Например, https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016
{% endnote %}
|⚙️ Лимит: 100 000 товаров в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"offer" : {
"vendor" : "LEVENHUK",
"basicPrice" : {
"value" : 0.9301444243932576
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"description" : "description",
"category" : "category",
"barcodes" : [ "46012300000000", "46012300000000" ],
"vendorCode" : "VNDR-0005A"
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
}, {
"offer" : {
"vendor" : "LEVENHUK",
"basicPrice" : {
"value" : 0.9301444243932576
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"description" : "description",
"category" : "category",
"barcodes" : [ "46012300000000", "46012300000000" ],
"vendorCode" : "VNDR-0005A"
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Подобранные карточки на Маркете.
По результатам проверки товара полученная через этот запрос карточка может быть заменена на другую.
GetSuggestedOfferMappingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/update
Добавление товаров в каталог и изменение информации о них (updateOfferMappings)
Добавляет товары в каталог, передает их категории на Маркете и характеристики, необходимые для этих категории. Также редактирует информацию об уже имеющихся товарах.
Список категорий Маркета можно получить с помощью запроса POST categories/tree, а характеристики товаров по категориям с помощью POST category/{categoryId}/parameters.
Чтобы добавить новый товар, передайте его с новым идентификатором, который раньше никогда не использовался в каталоге. Старайтесь сразу передать как можно больше информации — она потребуется Маркету для подбора подходящей карточки или создания новой. Если известно, какой карточке на Маркете соответствует товар, можно сразу указать идентификатор этой карточки (SKU на Маркете) в поле marketSKU.
Для новых товаров обязательно укажите параметры: offerId, name, marketCategoryId или category, pictures, vendor, description.
Чтобы отредактировать информацию о товаре, передайте новые данные, указав в offerId соответствующий ваш SKU. Поля, в которых ничего не меняется, можно не передавать.
Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.
Параметр offerId должен быть уникальным для всех товаров, которые вы передаете.
{% note warning "Правила использования SKU" %}
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
{% endnote %}
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"results" : [ {
"warnings" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ]
}, {
"warnings" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ]
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Все обязательные поля товаров заполнены, поэтому новые товары и внесенные изменения сохранены в каталоге.
UpdateOfferMappingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/settings
Настройки кабинета (getBusinessSettings)
Возвращает информацию о настройках кабинета, идентификатор которого указан в запросе.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Return type
Example data
Content-Type: application/json
{
"result" : {
"settings" : {
"currency" : "RUR",
"onlyDefaultPrice" : true
},
"info" : {
"name" : "name",
"id" : 0
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Настройки кабинета.
GetBusinessSettingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}
Информация о магазине (getCampaign)
Возвращает информацию о магазине.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"campaign" : {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о магазине.
GetCampaignResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/logins
Логины, связанные с магазином (getCampaignLogins)
Возвращает список логинов, у которых есть доступ к магазину.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"logins" : [ "logins", "logins" ]
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список логинов, связанных с магазином.
GetCampaignLoginsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/region
Регион магазина (getCampaignRegion)
{% note warning "" %}
Этот метод устарел. Вместо него используйте GET campaigns/{campaignId}/settings.
{% endnote %}
Возвращает регион, в котором находится магазин.
|⚙️ Лимит: 5 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Возвращает регион, в котором находится магазин.
|⚙️ Лимит: 1000 запросов в час|
|-|
GetCampaignRegionResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/settings
Настройки магазина (getCampaignSettings)
Возвращает информацию о настройках магазина, идентификатор которого указан в запросе.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"settings" : {
"showInPremium" : true,
"showInContext" : true,
"localRegion" : {
"delivery" : {
"schedule" : {
"customWorkingDays" : [ "23-09-2022", "23-09-2022" ],
"period" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022"
},
"customHolidays" : [ "23-09-2022", "23-09-2022" ],
"weeklyHolidays" : [ 1, 1 ],
"availableOnHolidays" : true,
"totalHolidays" : [ "23-09-2022", "23-09-2022" ]
}
},
"name" : "name",
"id" : 6,
"type" : "OTHER",
"deliveryOptionsSource" : "WEB"
},
"countryRegion" : 0,
"shopName" : "shopName",
"useOpenStat" : true
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Настройки магазина.
GetCampaignSettingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Список магазинов пользователя (getCampaigns)
Возвращает список магазинов, к которым имеет доступ пользователь — владелец авторизационного токена, использованного в запросе. Для агентских пользователей список состоит из подагентских магазинов.
|⚙️ Лимит: 1000 запросов в час|
|-|
Query parameters
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"campaigns" : [ {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
}, {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
} ],
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Магазины пользователя.
GetCampaignsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/by_login/{login}
Магазины, доступные логину (getCampaignsByLogin)
Возвращает список магазинов, к которым у пользователя с указанным логином есть доступ.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
login (required)
Path Parameter — Логин пользователя. default: null
Query parameters
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"campaigns" : [ {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
}, {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
} ],
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о магазинах.
GetCampaignsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /categories/max-sale-quantum
Лимит на установку кванта продажи и минимального количества товаров в заказе (getCategoriesMaxSaleQuantum)
Возвращает лимит на установку кванта и минимального количества товаров в заказе, которые вы можете задать для товаров указанных категорий.
Если вы передадите значение кванта или минимального количества товаров выше установленного Маркетом ограничения, товар будет скрыт с витрины.
Подробнее о том, как продавать товары по несколько штук, читайте в Справке Маркета для продавцов.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"results" : [ {
"maxSaleQuantum" : 6,
"name" : "name",
"id" : 0
}, {
"maxSaleQuantum" : 6,
"name" : "name",
"id" : 0
} ],
"errors" : [ {
"type" : "UNKNOWN_CATEGORY",
"categoryId" : 1
}, {
"type" : "UNKNOWN_CATEGORY",
"categoryId" : 1
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Лимит на установку кванта и минимального количества товаров.
GetCategoriesMaxSaleQuantumResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Дерево категорий (getCategoriesTree)
Возвращает дерево категорий Маркета.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Категории Маркета.
GetCategoriesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/new
Создание нового чата с покупателем (createChat)
Создает новый чат с покупателем.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"chatId" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Все получилось: чат создан.
CreateChatResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/history
Получение истории сообщений в чате (getChatHistory)
Возвращает историю сообщений в чате с покупателем.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"orderId" : 0,
"messages" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"sender" : "PARTNER",
"payload" : [ {
"size" : 1,
"name" : "name",
"url" : "url"
}, {
"size" : 1,
"name" : "name",
"url" : "url"
} ],
"messageId" : 6,
"message" : "message"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"sender" : "PARTNER",
"payload" : [ {
"size" : 1,
"name" : "name",
"url" : "url"
}, {
"size" : 1,
"name" : "name",
"url" : "url"
} ],
"messageId" : 6,
"message" : "message"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
История сообщений успешно получена.
GetChatHistoryResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats
Получение доступных чатов (getChats)
Возвращает ваши чаты с покупателями.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"chats" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"chatId" : 0,
"orderId" : 6,
"type" : "CHAT",
"status" : "NEW",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"chatId" : 0,
"orderId" : 6,
"type" : "CHAT",
"status" : "NEW",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список чатов.
GetChatsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/file/send
Отправка файла в чат (sendFileToChat)
Отправляет файл в чат с покупателем.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Query parameters
chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
Form parameters
file (required)
Form Parameter — Содержимое файла. Максимальный размер файла — 5 Мбайт. default: null format: binary
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ. Означает, что файл отправлен.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/message
Отправка сообщения в чат (sendMessageToChat)
Отправляет сообщение в чат с покупателем.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ. Означает, что сообщение отправлено.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /category/{categoryId}/parameters
Списки характеристик товаров по категориям (getCategoryContentParameters)
Возвращает список характеристик с допустимыми значениями для заданной категории.
|⚙️ Лимит: 50 категорий в минуту |
|-|
Path parameters
categoryId (required)
Path Parameter —
Идентификатор категории на Маркете.
Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом POST categories/tree.
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"parameters" : [ {
"values" : [ {
"description" : "description",
"id" : 5,
"value" : "value"
}, {
"description" : "description",
"id" : 5,
"value" : "value"
} ],
"recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
"description" : "description",
"type" : "TEXT",
"constraints" : {
"minValue" : 2.3021358869347655,
"maxValue" : 7.061401241503109,
"maxLength" : 9
},
"required" : true,
"multivalue" : true,
"unit" : {
"defaultUnitId" : 1,
"units" : [ {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
}, {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
} ]
},
"valueRestrictions" : [ {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
}, {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
} ],
"distinctive" : true,
"name" : "name",
"id" : 6,
"filtering" : true,
"allowCustomValues" : true
}, {
"values" : [ {
"description" : "description",
"id" : 5,
"value" : "value"
}, {
"description" : "description",
"id" : 5,
"value" : "value"
} ],
"recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
"description" : "description",
"type" : "TEXT",
"constraints" : {
"minValue" : 2.3021358869347655,
"maxValue" : 7.061401241503109,
"maxLength" : 9
},
"required" : true,
"multivalue" : true,
"unit" : {
"defaultUnitId" : 1,
"units" : [ {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
}, {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
} ]
},
"valueRestrictions" : [ {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
}, {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
} ],
"distinctive" : true,
"name" : "name",
"id" : 6,
"filtering" : true,
"allowCustomValues" : true
} ],
"categoryId" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список характеристик товаров из заданной категории.
GetCategoryContentParametersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-cards
Получение информации о заполненности карточек магазина (getOfferCardsContentStatus)
Возвращает сведения о состоянии контента для заданных товаров:
- создана ли карточка товара и в каком она статусе;
- заполненность карточки в процентах;
- переданные характеристики товаров;
- есть ли ошибки или предупреждения, связанные с контентом;
- рекомендации по заполнению карточки.
|⚙️ Лимит: 600 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offerCards" : [ {
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"offerId" : "offerId",
"contentRating" : 0,
"recommendations" : [ {
"type" : "HAS_VIDEO",
"percent" : 60
}, {
"type" : "HAS_VIDEO",
"percent" : 60
} ],
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"parameterValues" : [ {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
}, {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
} ]
}, {
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"offerId" : "offerId",
"contentRating" : 0,
"recommendations" : [ {
"type" : "HAS_VIDEO",
"percent" : 60
}, {
"type" : "HAS_VIDEO",
"percent" : 60
} ],
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"parameterValues" : [ {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
}, {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
} ]
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о карточках указанных товаров.
GetOfferCardsContentStatusResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-cards/update
Редактирование категорийных характеристик товара (updateOfferContent)
Редактирует характеристики товара, которые специфичны для категории, к которой он относится.
{% note warning "Здесь только то, что относится к конкретной категории" %}
Если вам нужно изменить основные параметры товара (название, описание, изображения, видео, производитель, штрихкод), воспользуйтесь запросом POST businesses/{businessId}/offer-mappings/update.
{% endnote %}
Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"results" : [ {
"warnings" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ]
}, {
"warnings" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ]
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Запрос выполнен корректно, данные обработаны.
{% note warning "Ответ 200 сам по себе не значит, что переданные значения корректны" %}
Обязательно посмотрите детали ответа: status и перечень ошибок, если он есть.
Даже если ошибка допущена в характеристиках всего одного товара, никакие изменения из запроса в каталог не попадут.
{% endnote %}
Если в status вернулось ERROR, убедитесь, что:
- все обязательные характеристики заполнены;
- характеристики действительно существуют в указанных категориях;
- значения соответствуют характеристикам;
- ваши собственные значения имеют нужный тип данных.
Найти проблемы помогут поля errors и warnings.
UpdateOfferContentResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/cancellation/accept
Отмена заказа покупателем (acceptOrderCancellation)
Подтверждает или отклоняет запрос покупателя на отмену заказа, который передан службе доставки.
Покупатель может отменить заказ в течение его обработки или доставки. Если заказ еще обрабатывается (имеет статус PROCESSING), вам не нужно подтверждать отмену заказа — он будет отменен автоматически.
Если заказ уже передан службе доставки (принимает статус DELIVERY или PICKUP) и пользователь отменил его, вы можете предупредить службу об отмене в течение 48 часов. Если служба доставки узнала об отмене до передачи заказа покупателю, подтвердите отмену с помощью запроса PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept. Если заказ уже доставлен, отклоните отмену с помощью этого же запроса. Тогда у покупателя останется заказ, и деньги за него возвращаться не будут.
Чтобы узнать, какие заказы были отменены в статусе DELIVERY или PICKUP, отправьте запрос GET campaigns/{campaignId}/orders. В его URL добавьте входной параметр onlyWaitingForCancellationApprove=true. Вы также можете узнать об отмененных заказах в кабинете или через почту — на нее придет уведомление об отмене.
Если в течение 48 часов вы не подтвердите или отклоните отмену, заказ будет отменен автоматически.
|⚙️ Лимит: 500 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ на отмену заказа был успешно передан.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/hidden-offers
Скрытие товаров и настройки скрытия (addHiddenOffers)
Скрывает товары магазина на Маркете.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Настройки скрытия получены и скоро вступят в силу.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/archive
Добавление товаров в архив (addOffersToArchive)
Помещает товары в архив. Товары, помещенные в архив, скрыты с витрины во всех магазинах кабинета.
{% note warning "В архив нельзя отправить товар, который хранится на складе Маркета" %}
Вначале такой товар нужно распродать или вывезти.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notArchivedOffers" : [ {
"offerId" : "offerId",
"error" : "OFFER_HAS_STOCKS"
}, {
"offerId" : "offerId",
"error" : "OFFER_HAS_STOCKS"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если некоторые товары добавить в архив не удалось, в ответе 200 будет их список.
Список успешно добавленных товаров не возвращается.
AddOffersToArchiveResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /tariffs/calculate
Калькулятор стоимости услуг (calculateTariffs)
Рассчитывает стоимость услуг Маркета для товаров с заданными параметрами. Порядок товаров в запросе и ответе сохраняется, чтобы определить,
для какого товара рассчитана стоимость услуги.
Обратите внимание: калькулятор осуществляет примерные расчеты. Финальная стоимость для каждого заказа зависит от предоставленных услуг.
В запросе можно указать либо параметр campaignId, либо sellingProgram. Совместное использование параметров приведет к ошибке.
|⚙️ Лимит: 100 запросов в минуту|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"offer" : {
"quantity" : 1,
"price" : 0.6027456183070403,
"length" : 0.14658129805029452,
"width" : 0.5962133916683182,
"weight" : 0.23021358869347652,
"categoryId" : 0,
"height" : 0.5637376656633328
},
"tariffs" : [ {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
}, {
"offer" : {
"quantity" : 1,
"price" : 0.6027456183070403,
"length" : 0.14658129805029452,
"width" : 0.5962133916683182,
"weight" : 0.23021358869347652,
"categoryId" : 0,
"height" : 0.5637376656633328
},
"tariffs" : [ {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Стоимость услуг.
CalculateTariffsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/price-quarantine/confirm
Удаление товара из карантина по цене в кабинете (confirmBusinessPrices)
Подтверждает основную цену на товары, которые попали в карантин, и удаляет их из карантина.
Основная цена задается в каталоге и действует во всех магазинах кабинета.
Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин
Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST businesses/{businessId}/price-quarantine.
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ 200 обозначает, что цены подтверждены.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/price-quarantine/confirm
Удаление товара из карантина по цене в магазине (confirmCampaignPrices)
Подтверждает в заданном магазине цену на товары, которые попали в карантин, и удаляет их из карантина.
Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин
Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST campaigns/{campaignId}/price-quarantine.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ 200 обозначает, что цены подтверждены.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/new
Создание нового чата с покупателем (createChat)
Создает новый чат с покупателем.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"chatId" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Все получилось: чат создан.
CreateChatResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/outlets
Создание точки продаж (createOutlet)
Создает точку продаж магазина на Маркете.
В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.
|⚙️ Лимит: 100 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"id" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о созданной точке продаж.
CreateOutletResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers/delete
Удаление товаров из ассортимента магазина (deleteCampaignOffers)
Удаляет заданные товары из заданного магазина.
{% note warning "Запрос удаляет товары именно из конкретного магазина" %}
На продажи в других магазинах и на наличие товара в общем каталоге он не влияет.
{% endnote %}
Товар не получится удалить, если он хранится на складах Маркета.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notDeletedOfferIds" : [ null, null ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине.
DeleteCampaignOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/comments/delete
Удаление комментария к отзыву (deleteGoodsFeedbackComment)
Удаляет комментарий магазина.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/hidden-offers/delete
Возобновление показа товаров (deleteHiddenOffers)
Возобновляет показ скрытых вами товаров магазина на Маркете.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Показ товаров возобновлен.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/delete
Удаление товаров из каталога (deleteOffers)
Удаляет товары из каталога.
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notDeletedOfferIds" : [ null, null ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине.
DeleteOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/unarchive
Удаление товаров из архива (deleteOffersFromArchive)
Восстанавливает товары из архива.
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notUnarchivedOfferIds" : [ null, null ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если некоторые товары восстановить из архива не удалось, в ответе 200 будет их список.
Список успешно восстановленных товаров не возвращается.
DeleteOffersFromArchiveResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
delete /campaigns/{campaignId}/outlets/{outletId}
Удаление точки продаж (deleteOutlet)
Удаляет точку продаж магазина на Маркете.
В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.
|⚙️ Лимит: 100 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
outletId (required)
Path Parameter — Идентификатор точки продаж. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
delete /campaigns/{campaignId}/outlets/licenses
Удаление лицензий для точек продаж (deleteOutletLicenses)
Удаляет информацию о лицензиях для точек продаж.
В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.
|⚙️ Лимит: 100 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
ids (optional)
Query Parameter — Список идентификаторов лицензий. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos/offers/delete
Удаление товаров из акции (deletePromoOffers)
Убирает товары из акции.
Изменения начинают действовать в течение 4–6 часов.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"rejectedOffers" : [ {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
}, {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Результат удаления товаров из акции.
DeletePromoOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/boost-consolidated/generate
Отчет по бусту продаж (generateBoostConsolidatedReport)
Запускает генерацию сводного отчета по бусту продаж за заданный период. Отчет содержит информацию по всем кампаниям, созданным и через API, и в кабинете.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/competitors-position/generate
Отчет «Конкурентная позиция» (generateCompetitorsPositionReport)
Запускает генерацию отчета «Конкурентная позиция» за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
{% note info "Значение -1 в отчете" %}
Если в CSV-файле в столбце POSITION стоит -1, в этот день не было заказов с товарами в указанной категории.
{% endnote %}
|⚙️ Лимит: 10 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/goods-feedback/generate
Отчет по отзывам о товарах (generateGoodsFeedbackReport)
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/documents/labels/generate
Готовые ярлыки‑наклейки на все коробки в нескольких заказах (generateMassOrderLabelsReport)
Запускает генерацию PDF-файла с ярлыками для переданных заказов. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке Маркета для продавцов.
Узнать статус генерации и получить ссылку на готовый файл можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 1000 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый файл.
Если при генерации не удалось найти часть заказов, в ответе на запрос получения готового файла вернется подстатус RESOURCE_NOT_FOUND.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label
Готовый ярлык‑наклейка для коробки в заказе (generateOrderLabel)
Формирует ярлык‑наклейку для коробки в заказе и возвращает ярлык в PDF‑файле.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор грузоместа. default: null format: int64
boxId (required)
Path Parameter — Идентификатор коробки. default: null format: int64
Query parameters
format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. default: null
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/pdfapplication/json
Responses
200
PDF‑файл с ярлыками для коробки. Файл содержит одну страницу с ярлыком.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/labels
Готовые ярлыки‑наклейки на все коробки в одном заказе (generateOrderLabels)
Возвращает PDF-файл с ярлыками, которые нужно наклеить на коробки перед отгрузкой. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке Маркета для продавцов.
На вход нужно передать идентификатор заказа и один необязательный параметр, который управляет версткой PDF-файла.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Query parameters
format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. default: null
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/pdfapplication/json
Responses
200
PDF‑файл с ярлыками на все коробки.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/prices/generate
Отчет «Цены на рынке» (generatePricesReport)
Запускает генерацию отчета «Цены на рынке».
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/shelf-statistics/generate
Отчет по полкам (generateShelfsStatisticsReport)
Запускает генерацию сводного отчета по полкам — рекламным блокам с баннером или видео и набором товаров. Подробнее о них читайте в Справке Маркета для продавцов.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/shows-sales/generate
Отчет «Аналитика продаж» (generateShowsSalesReport)
Запускает генерацию отчета «Аналитика продаж» за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 10 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/stocks-on-warehouses/generate
Отчет по остаткам на складах (generateStocksOnWarehousesReport)
Запускает генерацию отчета по остаткам на складах. Отчет содержит данные:
- Для модели FBY — об остатках на складах Маркета.
- Для остальных моделей — об остатках на соответствующем складе магазина.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/united-marketplace-services/generate
Отчет по стоимости услуг (generateUnitedMarketplaceServicesReport)
Запускает генерацию отчета по стоимости услуг за заданный период. Что это за отчет
Тип отчета зависит от того, какие поля заполнены в запросе:
|Тип отчета |Какие поля нужны |
|-----------------------------|---------------------------------|
|По дате начисления услуги |dateFrom и dateTo |
|По дате формирования акта |year и month |
Заказать отчеты обоих типов одним запросом нельзя.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/united-netting/generate
Отчет по платежам (generateUnitedNettingReport)
Запускает генерацию отчета по платежам за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
Тип отчета зависит от того, какие поля заполнены в запросе:
|Тип отчета |Какие поля нужны |
|-------------------------|---------------------------------------|
|О платежах за период |dateFrom и dateTo |
|О платежном поручении |bankOrderId и bankOrderDateTime |
Заказать отчеты обоих типов одним запросом нельзя.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/united-orders/generate
Отчет по заказам (generateUnitedOrdersReport)
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offers/all
Все предложения магазина (getAllOffers)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет максимально быстро получить информацию обо всех предложениях магазина, размещенных на Маркете. Возвращает результат в виде сегментов нефиксированного размера.
В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Яндекс Маркета, с которой соотнесено предложение, а также аукционные ставки на него.
{% note info %}
Количество предложений считается по данным за последние семь дней (не включая сегодня).
Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
chunk (optional)
Query Parameter —
Номер сегмента с результатами.
Значение по умолчанию: 0.
{% note info %}
Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.
{% endnote %}
{% note alert %}
Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать chunk=0 и т. д.
{% endnote %}
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"offers" : [ {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
}, {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
} ]
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Предложения магазина.
GetAllOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/bids/info
Информация об установленных ставках (getBidsInfoForBusiness)
Возвращает значения ставок для заданных товаров.
{% note warning "" %}
В ответе возвращаются значения только тех ставок, которые вы установили через запрос PUT businesses/{businessId}/bids. Получить информацию по кампаниям, созданным в кабинете, не получится.
{% endnote %}
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"bids" : [ {
"sku" : "sku",
"bid" : 570
}, {
"sku" : "sku",
"bid" : 570
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Значения ставок для заданных товаров. В ответ попадают только товары, на которые установлены ставки.
GetBidsInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/bids/recommendations
Рекомендованные ставки для заданных товаров (getBidsRecommendations)
Возвращает рекомендованные ставки для заданных товаров — такие ставки обеспечивают вашим предложениям определенную долю показов, если цена не превышает рекомендованную.
Для одного товара может возвращаться одна рекомендованная ставка или несколько. Во втором случае разные ставки предназначены для достижения разной доли показов.
Если товар только добавлен в каталог, но пока не продается, рекомендованной ставки для него не будет.
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"recommendations" : [ {
"bidRecommendations" : [ {
"showPercent" : 8,
"bid" : 570
}, {
"showPercent" : 8,
"bid" : 570
} ],
"priceRecommendations" : [ {
"campaignId" : 6,
"price" : 1.1465812980502945
}, {
"campaignId" : 6,
"price" : 1.1465812980502945
} ],
"sku" : "sku",
"bid" : 570
}, {
"bidRecommendations" : [ {
"showPercent" : 8,
"bid" : 570
}, {
"showPercent" : 8,
"bid" : 570
} ],
"priceRecommendations" : [ {
"campaignId" : 6,
"price" : 1.1465812980502945
}, {
"campaignId" : 6,
"price" : 1.1465812980502945
} ],
"sku" : "sku",
"bid" : 570
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Рекомендованные ставки для заданных товаров.
GetBidsRecommendationsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/price-quarantine
Список товаров, находящихся в карантине по цене в кабинете (getBusinessQuarantineOffers)
Возвращает список товаров, которые находятся в карантине по основной цене. Основная цена задается в каталоге и действует во всех магазинах кабинета.
Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST businesses/{businessId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST businesses/{businessId}/offer-prices/updates.
{% note info "𝓠 Что такое карантин?" %}
𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее
{% endnote %}
В запросе можно использовать фильтры.
Результаты возвращаются постранично.
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
}, {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров в карантине.
GetQuarantineOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/settings
Настройки кабинета (getBusinessSettings)
Возвращает информацию о настройках кабинета, идентификатор которого указан в запросе.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Return type
Example data
Content-Type: application/json
{
"result" : {
"settings" : {
"currency" : "RUR",
"onlyDefaultPrice" : true
},
"info" : {
"name" : "name",
"id" : 0
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Настройки кабинета.
GetBusinessSettingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}
Информация о магазине (getCampaign)
Возвращает информацию о магазине.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"campaign" : {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о магазине.
GetCampaignResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/logins
Логины, связанные с магазином (getCampaignLogins)
Возвращает список логинов, у которых есть доступ к магазину.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"logins" : [ "logins", "logins" ]
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список логинов, связанных с магазином.
GetCampaignLoginsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers
Информация о товарах, которые размещены в заданном магазине (getCampaignOffers)
Возвращает список товаров, которые размещены в заданном магазине. Для каждого товара указываются параметры размещения.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"campaignPrice" : {
"vat" : 5,
"discountBase" : 5.962133916683182,
"currencyId" : "RUR",
"value" : 1.4658129805029452,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"available" : true,
"offerId" : "offerId",
"quantum" : {
"minQuantity" : 1,
"stepQuantity" : 60
},
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"status" : "PUBLISHED"
}, {
"campaignPrice" : {
"vat" : 5,
"discountBase" : 5.962133916683182,
"currencyId" : "RUR",
"value" : 1.4658129805029452,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"available" : true,
"offerId" : "offerId",
"quantum" : {
"minQuantity" : 1,
"stepQuantity" : 60
},
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"status" : "PUBLISHED"
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров, размещенных в заданном магазине.
GetCampaignOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/price-quarantine
Список товаров, находящихся в карантине по цене в магазине (getCampaignQuarantineOffers)
Возвращает список товаров, которые находятся в карантине по цене, установленной в заданном магазине.
Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST campaigns/{campaignId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST campaigns/{campaignId}/offer-prices/updates.
{% note info "𝓠 Что такое карантин?" %}
𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее
{% endnote %}
В запросе можно использовать фильтры.
Результаты возвращаются постранично.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
}, {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров в карантине.
GetQuarantineOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/region
Регион магазина (getCampaignRegion)
{% note warning "" %}
Этот метод устарел. Вместо него используйте GET campaigns/{campaignId}/settings.
{% endnote %}
Возвращает регион, в котором находится магазин.
|⚙️ Лимит: 5 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Возвращает регион, в котором находится магазин.
|⚙️ Лимит: 1000 запросов в час|
|-|
GetCampaignRegionResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/settings
Настройки магазина (getCampaignSettings)
Возвращает информацию о настройках магазина, идентификатор которого указан в запросе.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"settings" : {
"showInPremium" : true,
"showInContext" : true,
"localRegion" : {
"delivery" : {
"schedule" : {
"customWorkingDays" : [ "23-09-2022", "23-09-2022" ],
"period" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022"
},
"customHolidays" : [ "23-09-2022", "23-09-2022" ],
"weeklyHolidays" : [ 1, 1 ],
"availableOnHolidays" : true,
"totalHolidays" : [ "23-09-2022", "23-09-2022" ]
}
},
"name" : "name",
"id" : 6,
"type" : "OTHER",
"deliveryOptionsSource" : "WEB"
},
"countryRegion" : 0,
"shopName" : "shopName",
"useOpenStat" : true
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Настройки магазина.
GetCampaignSettingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Список магазинов пользователя (getCampaigns)
Возвращает список магазинов, к которым имеет доступ пользователь — владелец авторизационного токена, использованного в запросе. Для агентских пользователей список состоит из подагентских магазинов.
|⚙️ Лимит: 1000 запросов в час|
|-|
Query parameters
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"campaigns" : [ {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
}, {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
} ],
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Магазины пользователя.
GetCampaignsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/by_login/{login}
Магазины, доступные логину (getCampaignsByLogin)
Возвращает список магазинов, к которым у пользователя с указанным логином есть доступ.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
login (required)
Path Parameter — Логин пользователя. default: null
Query parameters
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"campaigns" : [ {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
}, {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
} ],
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о магазинах.
GetCampaignsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /categories/max-sale-quantum
Лимит на установку кванта продажи и минимального количества товаров в заказе (getCategoriesMaxSaleQuantum)
Возвращает лимит на установку кванта и минимального количества товаров в заказе, которые вы можете задать для товаров указанных категорий.
Если вы передадите значение кванта или минимального количества товаров выше установленного Маркетом ограничения, товар будет скрыт с витрины.
Подробнее о том, как продавать товары по несколько штук, читайте в Справке Маркета для продавцов.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"results" : [ {
"maxSaleQuantum" : 6,
"name" : "name",
"id" : 0
}, {
"maxSaleQuantum" : 6,
"name" : "name",
"id" : 0
} ],
"errors" : [ {
"type" : "UNKNOWN_CATEGORY",
"categoryId" : 1
}, {
"type" : "UNKNOWN_CATEGORY",
"categoryId" : 1
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Лимит на установку кванта и минимального количества товаров.
GetCategoriesMaxSaleQuantumResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Дерево категорий (getCategoriesTree)
Возвращает дерево категорий Маркета.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Категории Маркета.
GetCategoriesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /category/{categoryId}/parameters
Списки характеристик товаров по категориям (getCategoryContentParameters)
Возвращает список характеристик с допустимыми значениями для заданной категории.
|⚙️ Лимит: 50 категорий в минуту |
|-|
Path parameters
categoryId (required)
Path Parameter —
Идентификатор категории на Маркете.
Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом POST categories/tree.
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"parameters" : [ {
"values" : [ {
"description" : "description",
"id" : 5,
"value" : "value"
}, {
"description" : "description",
"id" : 5,
"value" : "value"
} ],
"recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
"description" : "description",
"type" : "TEXT",
"constraints" : {
"minValue" : 2.3021358869347655,
"maxValue" : 7.061401241503109,
"maxLength" : 9
},
"required" : true,
"multivalue" : true,
"unit" : {
"defaultUnitId" : 1,
"units" : [ {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
}, {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
} ]
},
"valueRestrictions" : [ {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
}, {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
} ],
"distinctive" : true,
"name" : "name",
"id" : 6,
"filtering" : true,
"allowCustomValues" : true
}, {
"values" : [ {
"description" : "description",
"id" : 5,
"value" : "value"
}, {
"description" : "description",
"id" : 5,
"value" : "value"
} ],
"recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
"description" : "description",
"type" : "TEXT",
"constraints" : {
"minValue" : 2.3021358869347655,
"maxValue" : 7.061401241503109,
"maxLength" : 9
},
"required" : true,
"multivalue" : true,
"unit" : {
"defaultUnitId" : 1,
"units" : [ {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
}, {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
} ]
},
"valueRestrictions" : [ {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
}, {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
} ],
"distinctive" : true,
"name" : "name",
"id" : 6,
"filtering" : true,
"allowCustomValues" : true
} ],
"categoryId" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список характеристик товаров из заданной категории.
GetCategoryContentParametersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/history
Получение истории сообщений в чате (getChatHistory)
Возвращает историю сообщений в чате с покупателем.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"orderId" : 0,
"messages" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"sender" : "PARTNER",
"payload" : [ {
"size" : 1,
"name" : "name",
"url" : "url"
}, {
"size" : 1,
"name" : "name",
"url" : "url"
} ],
"messageId" : 6,
"message" : "message"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"sender" : "PARTNER",
"payload" : [ {
"size" : 1,
"name" : "name",
"url" : "url"
}, {
"size" : 1,
"name" : "name",
"url" : "url"
} ],
"messageId" : 6,
"message" : "message"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
История сообщений успешно получена.
GetChatHistoryResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats
Получение доступных чатов (getChats)
Возвращает ваши чаты с покупателями.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"chats" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"chatId" : 0,
"orderId" : 6,
"type" : "CHAT",
"status" : "NEW",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"chatId" : 0,
"orderId" : 6,
"type" : "CHAT",
"status" : "NEW",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список чатов.
GetChatsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /delivery/services
Справочник служб доставки (getDeliveryServices)
Возвращает справочник служб доставки: идентификаторы и наименования.
|⚙️ Лимит: 5 000 запросов в час|
|-|
Return type
Example data
Content-Type: application/json
{
"result" : {
"deliveryService" : [ {
"name" : "name",
"id" : 0
}, {
"name" : "name",
"id" : 0
} ]
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о службах доставки.
GetDeliveryServicesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feeds/{feedId}
Информация о прайс-листе (getFeed)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает информацию о прайс-листе, размещенном на Маркете для заданного магазина. Также ресурс возвращает результаты автоматических проверок прайс-листа.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"feed" : {
"password" : "password",
"download" : {
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 5
}
},
"uploadDate" : "2000-01-23T04:56:07.000+00:00",
"publication" : {
"priceAndStockUpdate" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
},
"full" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
}
},
"name" : "name",
"id" : 0,
"placement" : {
"totalOffersCount" : 5
},
"login" : "login",
"url" : "url",
"content" : {
"rejectedOffersCount" : 6,
"error" : {
"type" : "PARSE_ERROR"
},
"status" : "ERROR",
"totalOffersCount" : 1
}
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о прайс-листе.
GetFeedResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feeds/{feedId}/index-logs
Отчет по индексации прайс-листа (getFeedIndexLogs)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает отчет по индексации прайс-листа для заданного магазина. Отчет позволяет получить статистику загрузки прайс-листа и результаты его автоматических проверок.
Данные в отчете возвращаются в порядке убывания значений параметра generationId.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Query parameters
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
published_time_from (optional)
Query Parameter —
Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
Значение по умолчанию: последние восемь дней со времени отправки запроса.
default: null format: date-time
published_time_to (optional)
Query Parameter —
Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-31T00:42:42+03:00.
Значение по умолчанию: дата и время отправки запроса.
{% note info %}
Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра published_time_to. Значение параметра не должно быть датой из будущего.
{% endnote %}
default: null format: date-time
status (optional)
Query Parameter —
Статус индексации и проверки прайс-листа на соответствие техническим требованиям.
Возможные значения:
ERROR — произошли ошибки.OK — обработан без ошибок.WARNING — наблюдались некритичные проблемы.
default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"feed" : {
"id" : 0
},
"total" : 2,
"indexLogRecords" : [ {
"offers" : {
"rejectedCount" : 5,
"totalCount" : 5
},
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"generationId" : 6,
"indexType" : "DIFF",
"publishedTime" : "2000-01-23T04:56:07.000+00:00",
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 1
},
"downloadTime" : "2000-01-23T04:56:07.000+00:00",
"status" : "ERROR"
}, {
"offers" : {
"rejectedCount" : 5,
"totalCount" : 5
},
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"generationId" : 6,
"indexType" : "DIFF",
"publishedTime" : "2000-01-23T04:56:07.000+00:00",
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 1
},
"downloadTime" : "2000-01-23T04:56:07.000+00:00",
"status" : "ERROR"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Отчет по индексации прайс-листа.
GetFeedIndexLogsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feedback/updates
Новые и обновленные отзывы о магазине (getFeedbackAndCommentUpdates)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает новые и обновленные отзывы о магазине на Маркете.
Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Выходные данные содержат идентификатор следующей страницы.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
from_date (optional)
Query Parameter —
Начальная дата обновления отзывов.
Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.
Формат даты: ГГГГ-ММ-ДД.
default: null format: date
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
},
"feedbackList" : [ {
"comments" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"shop" : {
"name" : "name"
},
"author" : {
"name" : "name",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}
},
"verified" : true,
"recommend" : true,
"grades" : {
"average" : 5.962133916683182,
"agreeCount" : 5,
"rejectCount" : 2,
"factors" : [ {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
}, {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
} ]
},
"pro" : "pro",
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"text" : "text",
"state" : "LAST",
"contra" : "contra",
"resolved" : true,
"order" : {
"delivery" : "DELIVERY",
"shopOrderId" : "shopOrderId"
}
}, {
"comments" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"shop" : {
"name" : "name"
},
"author" : {
"name" : "name",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}
},
"verified" : true,
"recommend" : true,
"grades" : {
"average" : 5.962133916683182,
"agreeCount" : 5,
"rejectCount" : 2,
"factors" : [ {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
}, {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
} ]
},
"pro" : "pro",
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"text" : "text",
"state" : "LAST",
"contra" : "contra",
"resolved" : true,
"order" : {
"delivery" : "DELIVERY",
"shopOrderId" : "shopOrderId"
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список отзывов для магазина.
GetFeedbackListResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feeds
Список прайс-листов магазина (getFeeds)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает список прайс-листов, размещенных на Маркете для магазина. Также ресурс возвращает результаты автоматических проверок прайс-листов.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"feeds" : [ {
"password" : "password",
"download" : {
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 5
}
},
"uploadDate" : "2000-01-23T04:56:07.000+00:00",
"publication" : {
"priceAndStockUpdate" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
},
"full" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
}
},
"name" : "name",
"id" : 0,
"placement" : {
"totalOffersCount" : 5
},
"login" : "login",
"url" : "url",
"content" : {
"rejectedOffersCount" : 6,
"error" : {
"type" : "PARSE_ERROR"
},
"status" : "ERROR",
"totalOffersCount" : 1
}
}, {
"password" : "password",
"download" : {
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 5
}
},
"uploadDate" : "2000-01-23T04:56:07.000+00:00",
"publication" : {
"priceAndStockUpdate" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
},
"full" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
}
},
"name" : "name",
"id" : 0,
"placement" : {
"totalOffersCount" : 5
},
"login" : "login",
"url" : "url",
"content" : {
"rejectedOffersCount" : 6,
"error" : {
"type" : "PARSE_ERROR"
},
"status" : "ERROR",
"totalOffersCount" : 1
}
} ]
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список прайс-листов.
GetFeedsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/comments
Получение комментариев к отзыву (getGoodsFeedbackComments)
Возвращает комментарии к отзыву.
Результаты возвращаются постранично, одна страница содержит не более 20 комментариев.
Комментарии расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"comments" : [ {
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 0,
"text" : "text",
"canModify" : true,
"parentId" : 6,
"status" : "PUBLISHED"
}, {
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 0,
"text" : "text",
"canModify" : true,
"parentId" : 6,
"status" : "PUBLISHED"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Дерево комментариев к отзыву.
GetGoodsFeedbackCommentsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback
Получение отзывов о товарах продавца (getGoodsFeedbacks)
Возвращает все отзывы о товарах продавца по указанным фильтрам.
Результаты возвращаются постранично, одна страница содержит не более 20 отзывов.
Отзывы расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"feedbacks" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"needReaction" : true,
"identifiers" : {
"orderId" : 6,
"modelId" : 1
},
"author" : "author",
"feedbackId" : 0,
"description" : {
"advantages" : "advantages",
"disadvantages" : "disadvantages",
"comment" : "comment"
},
"media" : {
"videos" : [ "videos", "videos" ],
"photos" : [ "photos", "photos" ]
},
"statistics" : {
"commentsCount" : 5,
"rating" : 3,
"paidAmount" : 2,
"recommended" : true
}
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"needReaction" : true,
"identifiers" : {
"orderId" : 6,
"modelId" : 1
},
"author" : "author",
"feedbackId" : 0,
"description" : {
"advantages" : "advantages",
"disadvantages" : "disadvantages",
"comment" : "comment"
},
"media" : {
"videos" : [ "videos", "videos" ],
"photos" : [ "photos", "photos" ]
},
"statistics" : {
"commentsCount" : 5,
"rating" : 3,
"paidAmount" : 2,
"recommended" : true
}
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список отзывов.
GetGoodsFeedbackResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/stats/skus
Отчет по товарам (getGoodsStats)
Возвращает подробный отчет по товарам, которые вы разместили на Маркете. С помощью отчета вы можете узнать, например, об остатках на складе, об условиях хранения ваших товаров и т. д.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"shopSkus" : [ {
"shopSku" : "shopSku",
"marketSku" : 0,
"price" : 6.027456183070403,
"name" : "name",
"warehouses" : [ {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
}, {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
} ],
"weightDimensions" : {
"length" : 5.962133916683182,
"width" : 5.637376656633329,
"weight" : 7.061401241503109,
"height" : 2.3021358869347655
},
"categoryName" : "categoryName",
"categoryId" : 1,
"pictures" : [ "pictures", "pictures" ],
"tariffs" : [ {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
}, {
"shopSku" : "shopSku",
"marketSku" : 0,
"price" : 6.027456183070403,
"name" : "name",
"warehouses" : [ {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
}, {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
} ],
"weightDimensions" : {
"length" : 5.962133916683182,
"width" : 5.637376656633329,
"weight" : 7.061401241503109,
"height" : 2.3021358869347655
},
"categoryName" : "categoryName",
"categoryId" : 1,
"pictures" : [ "pictures", "pictures" ],
"tariffs" : [ {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Отчет по товарам.
GetGoodsStatsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/hidden-offers
Информация о скрытых вами товарах (getHiddenOffers)
Возвращает список скрытых вами товаров для заданного магазина.
В списке будут товары, скрытые любым способом — по API, с помощью YML-фида, в кабинете и так далее.
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
offer_id (optional)
Query Parameter — Идентификатор скрытого предложения. default: null
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
offset (optional)
Query Parameter —
Позиция в списке, начиная с которой возвращаются результаты ответа.
Используется вместе с параметром limit.
Если задан offset, параметры page_number и page_size игнорируются.
offset игнорируется, если задан page_token.
default: null format: int32
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"hiddenOffers" : [ {
"offerId" : "offerId"
}, {
"offerId" : "offerId"
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о скрытых вами товарах.
GetHiddenOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Информация об одной модели (getModel)
Возвращает информацию о модели товара.
Для методов GET models, GET models/{modelId} и POST models действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.
|⚙️ Лимит: рассчитывается индивидуально|
|-|
Path parameters
modelId (required)
Path Parameter — Идентификатор модели товара. default: null format: int64
Query parameters
regionId (required)
Query Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
currency (optional)
Query Parameter —
Валюта, в которой отображаются цены предложений на страницах с результатами поиска.
Возможные значения:
Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
default: null
Return type
Example data
Content-Type: application/json
{
"models" : [ {
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
}
}, {
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
}
} ],
"regionId" : 0,
"currency" : "RUR"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о модели.
GetModelsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /models/{modelId}/offers
Список предложений для одной модели (getModelOffers)
Возвращает информацию о первых десяти предложениях, расположенных на карточке модели.
Предложения выдаются для определенного региона и располагаются в том же порядке, в котором они показываются в выдаче Маркета на карточке модели.
Для групповых моделей метод не поддерживается. Идентификатор групповой модели игнорируется.
Для методов GET models/{modelId}/offers и POST models/offers действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.
|⚙️ Лимит: рассчитывается индивидуально|
|-|
Path parameters
modelId (required)
Path Parameter — Идентификатор модели товара. default: null format: int64
Query parameters
regionId (required)
Query Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
currency (optional)
Query Parameter —
Валюта, в которой отображаются цены предложений на страницах с результатами поиска.
Возможные значения:
Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
default: null
orderByPrice (optional)
Query Parameter —
Направление сортировки по цене.
Возможные значения:
ASC — сортировка по возрастанию.DESC — сортировка по убыванию.
Значение по умолчанию: предложения выводятся в произвольном порядке.
default: null
count (optional)
Query Parameter — Количество предложений на странице ответа. default: 10 format: int32
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
Return type
Example data
Content-Type: application/json
{
"models" : [ {
"offers" : [ {
"shopRating" : 9,
"preDiscountPrice" : 5.962133916683182,
"shippingCost" : 7.061401241503109,
"pos" : 1,
"regionId" : 2,
"price" : 5.637376656633329,
"name" : "name",
"discount" : 6,
"shopName" : "shopName",
"inStock" : 3
}, {
"shopRating" : 9,
"preDiscountPrice" : 5.962133916683182,
"shippingCost" : 7.061401241503109,
"pos" : 1,
"regionId" : 2,
"price" : 5.637376656633329,
"name" : "name",
"discount" : 6,
"shopName" : "shopName",
"inStock" : 3
} ],
"onlineOffers" : 4,
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
},
"offlineOffers" : 2
}, {
"offers" : [ {
"shopRating" : 9,
"preDiscountPrice" : 5.962133916683182,
"shippingCost" : 7.061401241503109,
"pos" : 1,
"regionId" : 2,
"price" : 5.637376656633329,
"name" : "name",
"discount" : 6,
"shopName" : "shopName",
"inStock" : 3
}, {
"shopRating" : 9,
"preDiscountPrice" : 5.962133916683182,
"shippingCost" : 7.061401241503109,
"pos" : 1,
"regionId" : 2,
"price" : 5.637376656633329,
"name" : "name",
"discount" : 6,
"shopName" : "shopName",
"inStock" : 3
} ],
"onlineOffers" : 4,
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
},
"offlineOffers" : 2
} ],
"regionId" : 7,
"currency" : "RUR"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список предложений для модели.
GetModelsOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Информация о нескольких моделях (getModels)
Возвращает информацию о моделях товаров.
В одном запросе можно получить информацию не более чем о 100 моделях.
Для методов GET models, GET models/{modelId} и POST models действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.
|⚙️ Лимит: рассчитывается индивидуально|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
regionId (required)
Query Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
currency (optional)
Query Parameter —
Валюта, в которой отображаются цены предложений на страницах с результатами поиска.
Возможные значения:
Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
default: null
Return type
Example data
Content-Type: application/json
{
"models" : [ {
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
}
}, {
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
}
} ],
"regionId" : 0,
"currency" : "RUR"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о моделях.
GetModelsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Список предложений для нескольких моделей (getModelsOffers)
Возвращает информацию о первых десяти предложениях, расположенных на карточках моделей, идентификаторы которых указаны в запросе.
Предложения выдаются для определенного региона и располагаются в том же порядке, в котором они показываются в выдаче Маркета на карточке модели.
Для групповых моделей выдача предложений не поддерживается. Идентификаторы групповых моделей игнорируются.
В одном запросе можно получить информацию о предложениях не более чем для 100 моделей.
Для методов GET models/{modelId}/offers и POST models/offers действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.
|⚙️ Лимит: рассчитывается индивидуально|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
regionId (required)
Query Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
currency (optional)
Query Parameter —
Валюта, в которой отображаются цены предложений на страницах с результатами поиска.
Возможные значения:
Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
default: null
orderByPrice (optional)
Query Parameter —
Направление сортировки по цене.
Возможные значения:
ASC — сортировка по возрастанию.DESC — сортировка по убыванию.
Значение по умолчанию: предложения выводятся в произвольном порядке.
default: null
Return type
Example data
Content-Type: application/json
{
"models" : [ {
"offers" : [ {
"shopRating" : 9,
"preDiscountPrice" : 5.962133916683182,
"shippingCost" : 7.061401241503109,
"pos" : 1,
"regionId" : 2,
"price" : 5.637376656633329,
"name" : "name",
"discount" : 6,
"shopName" : "shopName",
"inStock" : 3
}, {
"shopRating" : 9,
"preDiscountPrice" : 5.962133916683182,
"shippingCost" : 7.061401241503109,
"pos" : 1,
"regionId" : 2,
"price" : 5.637376656633329,
"name" : "name",
"discount" : 6,
"shopName" : "shopName",
"inStock" : 3
} ],
"onlineOffers" : 4,
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
},
"offlineOffers" : 2
}, {
"offers" : [ {
"shopRating" : 9,
"preDiscountPrice" : 5.962133916683182,
"shippingCost" : 7.061401241503109,
"pos" : 1,
"regionId" : 2,
"price" : 5.637376656633329,
"name" : "name",
"discount" : 6,
"shopName" : "shopName",
"inStock" : 3
}, {
"shopRating" : 9,
"preDiscountPrice" : 5.962133916683182,
"shippingCost" : 7.061401241503109,
"pos" : 1,
"regionId" : 2,
"price" : 5.637376656633329,
"name" : "name",
"discount" : 6,
"shopName" : "shopName",
"inStock" : 3
} ],
"onlineOffers" : 4,
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
},
"offlineOffers" : 2
} ],
"regionId" : 7,
"currency" : "RUR"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список предложений для моделей.
GetModelsOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-cards
Получение информации о заполненности карточек магазина (getOfferCardsContentStatus)
Возвращает сведения о состоянии контента для заданных товаров:
- создана ли карточка товара и в каком она статусе;
- заполненность карточки в процентах;
- переданные характеристики товаров;
- есть ли ошибки или предупреждения, связанные с контентом;
- рекомендации по заполнению карточки.
|⚙️ Лимит: 600 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offerCards" : [ {
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"offerId" : "offerId",
"contentRating" : 0,
"recommendations" : [ {
"type" : "HAS_VIDEO",
"percent" : 60
}, {
"type" : "HAS_VIDEO",
"percent" : 60
} ],
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"parameterValues" : [ {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
}, {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
} ]
}, {
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"offerId" : "offerId",
"contentRating" : 0,
"recommendations" : [ {
"type" : "HAS_VIDEO",
"percent" : 60
}, {
"type" : "HAS_VIDEO",
"percent" : 60
} ],
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"parameterValues" : [ {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
}, {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
} ]
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о карточках указанных товаров.
GetOfferCardsContentStatusResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offer-mapping-entries
Список товаров в каталоге (getOfferMappingEntries)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings.
{% endnote %}
Для каждого товара, который вы размещаете на Маркете, возвращается информация о карточках Маркета, к которым привязан этот товар:
- Идентификатор текущей карточки (marketSku), карточки, которая проходит модерацию и последней отклоненной карточки.
- Описание товара, которое указано на карточке Маркета. Например, размер упаковки и вес товара.
Результаты возвращаются постранично. Выходные данные содержат идентификатор следующей страницы.
{% note info %}
Количество товаров в каталоге магазина считается по данным за последние семь дней (не включая сегодня).
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
offer_id (optional)
Query Parameter — Идентификатор товара в каталоге. default: null
shop_sku (optional)
Query Parameter —
Ваш SKU товара.
Параметр может быть указан несколько раз, например:
...shop_sku=123&shop_sku=129&shop_sku=141...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
mapping_kind (optional)
Query Parameter — Тип маппинга. default: null
status (optional)
Query Parameter —
Фильтрация по статусу публикации товара:
READY — товар прошел модерацию.IN_WORK — товар проходит модерацию.NEED_CONTENT — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.NEED_INFO — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.REJECTED — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.SUSPENDED — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.OTHER — товар не прошел модерацию по другой причине.
Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
availability (optional)
Query Parameter —
Фильтрация по планам поставок товара:
ACTIVE — поставки будут.INACTIVE — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.DELISTED — архив: товар закончился на складе, и его поставок больше не будет.
Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
category_id (optional)
Query Parameter —
Фильтрация по идентификатору категории на Маркете.
Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом POST categories/tree.
Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
vendor (optional)
Query Parameter —
Фильтрация по бренду товара.
Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.
Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе Кодирование URL русскоязычной Википедии.
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offerMappingEntries" : [ {
"offer" : {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
},
"mapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"awaitingModerationMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"rejectedMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
}
}, {
"offer" : {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
},
"mapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"awaitingModerationMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"rejectedMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
}
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о товарах в каталоге.
GetOfferMappingEntriesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings
Информация о товарах в каталоге (getOfferMappings)
Возвращает список товаров в каталоге, их категории на Маркете и характеристики каждого товара.
Можно использовать тремя способами:
- задать список интересующих SKU;
- задать фильтр — в этом случае результаты возвращаются постранично;
- не передавать тело запроса, чтобы получить список всех товаров в каталоге.
|⚙️ Лимит: 600 запросов в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
},
"offerMappings" : [ {
"offer" : {
"downloadable" : true,
"sellingPrograms" : [ {
"sellingProgram" : "FBY",
"status" : "FINE"
}, {
"sellingProgram" : "FBY",
"status" : "FINE"
} ],
"marketCategoryId" : 0,
"manufacturerCountries" : [ "Россия", "Россия" ],
"description" : "description",
"videos" : [ "videos", "videos", "videos", "videos", "videos" ],
"purchasePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"type" : "DEFAULT",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"archived" : true,
"campaigns" : [ {
"campaignId" : 9,
"status" : "PUBLISHED"
}, {
"campaignId" : 9,
"status" : "PUBLISHED"
} ],
"vendor" : "LEVENHUK",
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"barcodes" : [ "46012300000000", "46012300000000" ],
"params" : [ {
"name" : "Wi-Fi",
"value" : "есть"
}, {
"name" : "Wi-Fi",
"value" : "есть"
} ],
"tags" : [ "до 500 рублей", "до 500 рублей" ],
"condition" : {
"reason" : "reason",
"type" : "PREOWNED",
"quality" : "PERFECT"
},
"certificates" : [ "certificates", "certificates" ],
"boxCount" : 1,
"additionalExpenses" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"customsCommodityCode" : "8517610008",
"adult" : true,
"age" : {
"ageUnit" : "YEAR",
"value" : 0.5962133916683182
},
"manuals" : [ {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
} ]
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
}, {
"offer" : {
"downloadable" : true,
"sellingPrograms" : [ {
"sellingProgram" : "FBY",
"status" : "FINE"
}, {
"sellingProgram" : "FBY",
"status" : "FINE"
} ],
"marketCategoryId" : 0,
"manufacturerCountries" : [ "Россия", "Россия" ],
"description" : "description",
"videos" : [ "videos", "videos", "videos", "videos", "videos" ],
"purchasePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"type" : "DEFAULT",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"archived" : true,
"campaigns" : [ {
"campaignId" : 9,
"status" : "PUBLISHED"
}, {
"campaignId" : 9,
"status" : "PUBLISHED"
} ],
"vendor" : "LEVENHUK",
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"barcodes" : [ "46012300000000", "46012300000000" ],
"params" : [ {
"name" : "Wi-Fi",
"value" : "есть"
}, {
"name" : "Wi-Fi",
"value" : "есть"
} ],
"tags" : [ "до 500 рублей", "до 500 рублей" ],
"condition" : {
"reason" : "reason",
"type" : "PREOWNED",
"quality" : "PERFECT"
},
"certificates" : [ "certificates", "certificates" ],
"boxCount" : 1,
"additionalExpenses" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"customsCommodityCode" : "8517610008",
"adult" : true,
"age" : {
"ageUnit" : "YEAR",
"value" : 0.5962133916683182
},
"manuals" : [ {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
} ]
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о товарах в каталоге.
GetOfferMappingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offers/recommendations
Рекомендации Маркета, касающиеся цен (getOfferRecommendations)
Метод возвращает рекомендации нескольких типов.
1. Порог для привлекательной цены. Он нужен для участия в софинансировании скидок.
Показывает, какие цены для участия нужно установить, чтобы получить максимальные шансы на срабатывание скидок, софинансируемых Маркетом. Как это устроено
2. Оценка привлекательности цен на витрине.
Привлекательность влияет на вероятность срабатывания скидок за счет Маркета. Как это устроено
В запросе можно использовать фильтры.
Результаты возвращаются постранично.
|⚙️ Лимит: 100 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
},
"offerRecommendations" : [ {
"offer" : {
"shows" : 0,
"price" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitiveness" : "OPTIMAL",
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}
},
"recommendation" : {
"recommendedCofinancePrice" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitivenessThresholds" : {
"optimalPrice" : {
"value" : 0.9301444243932576
},
"averagePrice" : {
"value" : 0.9301444243932576
}
}
}
}, {
"offer" : {
"shows" : 0,
"price" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitiveness" : "OPTIMAL",
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}
},
"recommendation" : {
"recommendedCofinancePrice" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitivenessThresholds" : {
"optimalPrice" : {
"value" : 0.9301444243932576
},
"averagePrice" : {
"value" : 0.9301444243932576
}
}
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров с рекомендациями.
GetOfferRecommendationsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offers
Предложения магазина (getOffers)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет фильтровать информацию о предложениях магазина, размещенных на Маркете, и искать предложения по заданному поисковому запросу.
Поиск предложений, размещенных на Маркете, работает по поисковому запросу аналогично поиску Маркета. Результаты возвращаются с использованием пейджера.
В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Маркета, с которой соотнесено предложение, и аукционные ставки на него.
{% note info %}
Из-за особенностей поиска Маркета иногда на последних страницах пейджера фактическое количество результатов оказывается меньше количества, указанного ранее на предыдущих страницах.
В связи с этим настоятельно рекомендуется анализировать содержимое параметра pager для каждой полученной страницы.
{% endnote %}
{% note info %}
Количество предложений считается по данным за последние семь дней (не включая сегодня).
Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
query (optional)
Query Parameter —
Поисковый запрос.
Поддерживается язык запросов.
Значение по умолчанию: все предложения магазина, размещенные на Маркете.
default: null
feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
shopCategoryId (optional)
Query Parameter —
Идентификатор категории предложения, указанный магазином в прайс-листе.
Параметр выводится только для предложений, у которых указана категория в прайс-листе.
Параметр доступен начиная с версии 2.0 партнерского API.
default: null
currency (optional)
Query Parameter —
Валюта, в которой указана цена предложения.
Возможные значения:
default: null
matched (optional)
Query Parameter —
Фильтр по признаку соотнесения предложения и карточки модели.
Возможные значения:
-
0 / FALSE / NO — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.
-
1 / TRUE / YES — поиск выполняется среди предложений, соотнесенных с карточками моделей).
default: null
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"offers" : [ {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
}, {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
} ],
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Предложения магазина.
GetOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}
Информация об одном заказе (getOrder)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"order" : {
"delivery" : {
"dispatchType" : "UNKNOWN",
"address" : {
"country" : "country",
"city" : "city",
"postcode" : "postcode",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"house" : "house",
"subway" : "subway",
"phone" : "phone",
"street" : "street",
"district" : "district",
"recipient" : "recipient",
"entryphone" : "entryphone",
"block" : "block",
"entrance" : "entrance",
"floor" : "floor",
"apartment" : "apartment"
},
"liftType" : "NOT_NEEDED",
"deliveryServiceId" : 6,
"estimated" : true,
"dates" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022",
"fromTime" : "fromTime",
"toTime" : "toTime",
"realDeliveryDate" : "23-09-2022"
},
"type" : "DELIVERY",
"serviceName" : "serviceName",
"shipments" : [ {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
}, {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
} ],
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ],
"courier" : {
"vehicleDescription" : "vehicleDescription",
"phone" : "phone",
"phoneExtension" : "phoneExtension",
"fullName" : "fullName",
"vehicleNumber" : "vehicleNumber"
},
"price" : 5.025004791520295,
"outletStorageLimitDate" : "23-09-2022",
"eacType" : "MERCHANT_TO_COURIER",
"liftPrice" : 8.762042012749001,
"eacCode" : "eacCode",
"id" : "id",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"deliveryPartnerType" : "SHOP",
"outletCode" : "outletCode"
},
"notes" : "notes",
"substatus" : "RESERVATION_EXPIRED",
"deliveryTotal" : 1.4658129805029452,
"buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
"creationDate" : "23-09-2022 09:12:41",
"buyerItemsTotal" : 5.962133916683182,
"paymentType" : "PREPAID",
"buyer" : {
"lastName" : "lastName",
"firstName" : "firstName",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"expiryDate" : "23-09-2022 09:12:41",
"buyerTotalBeforeDiscount" : 7.061401241503109,
"itemsTotal" : 6.027456183070403,
"buyerTotal" : 5.637376656633329,
"subsidies" : [ {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
} ],
"paymentMethod" : "CASH_ON_DELIVERY",
"currency" : "RUR",
"fake" : true,
"id" : 0,
"taxSystem" : "OSN",
"cancelRequested" : true,
"items" : [ {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
}, {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
} ],
"status" : "PLACING",
"updatedAt" : "23-09-2022 09:12:41"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о заказе.
GetOrderResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/{orderId}/business-buyer
Информация о покупателе — юридическом лице (getOrderBusinessBuyerInfo)
Возвращает информацию о покупателе по идентификатору заказа.
{% note info "" %}
Чтобы получить информацию о покупателе, который является физическим лицом, воспользуйтесь запросом GET campaigns/{campaignId}/orders/{orderId}/buyer.
{% endnote %}
Получить данные можно, только если заказ находится в статусе PROCESSING, DELIVERY, PICKUP или DELIVERED.
Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.
|⚙️ Лимит: 3 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"organizationName" : "organizationName",
"organizationJurAddress" : "organizationJurAddress",
"inn" : "inn",
"kpp" : "kpp"
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о покупателе.
GetBusinessBuyerInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/{orderId}/documents
Информация о документах (getOrderBusinessDocumentsInfo)
Возвращает информацию о документах по идентификатору заказа.
Получить данные можно после того, как заказ перейдет в статус DELIVERED.
Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.
|⚙️ Лимит: 3 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"sf" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"torgTwelve" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"upd" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"ukd" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"ksf" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о документах.
GetBusinessDocumentsInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/buyer
Информация о покупателе — физическом лице (getOrderBuyerInfo)
Возвращает информацию о покупателе по идентификатору заказа.
{% note info "" %}
Чтобы получить информацию о покупателе, который является юридическим лицом, воспользуйтесь запросом POST campaigns/{campaignId}/orders/{orderId}/business-buyer.
{% endnote %}
Получить данные можно, только если заказ находится в статусе PROCESSING, DELIVERY или PICKUP.
Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.
|⚙️ Лимит: 3 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"lastName" : "lastName",
"firstName" : "firstName",
"phone" : "phone",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о покупателе.
GetOrderBuyerInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/labels/data
Данные для самостоятельного изготовления ярлыков (getOrderLabelsData)
Возвращает информацию на ярлыках, которые клеятся на коробки в заказе.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"parcelBoxLabels" : [ {
"supplierName" : "supplierName",
"deliveryServiceId" : "deliveryServiceId",
"orderId" : 1,
"fulfilmentId" : "fulfilmentId",
"orderNum" : "orderNum",
"weight" : "weight",
"url" : "url",
"deliveryServiceName" : "deliveryServiceName",
"deliveryAddress" : "deliveryAddress",
"recipientName" : "recipientName",
"place" : "place",
"shipmentDate" : "shipmentDate",
"boxId" : 5
}, {
"supplierName" : "supplierName",
"deliveryServiceId" : "deliveryServiceId",
"orderId" : 1,
"fulfilmentId" : "fulfilmentId",
"orderNum" : "orderNum",
"weight" : "weight",
"url" : "url",
"deliveryServiceName" : "deliveryServiceName",
"deliveryAddress" : "deliveryAddress",
"recipientName" : "recipientName",
"place" : "place",
"shipmentDate" : "shipmentDate",
"boxId" : 5
} ],
"orderId" : 0,
"placesNumber" : 6,
"url" : "url"
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация для печати ярлыков.
GetOrderLabelsDataResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders
Информация о нескольких заказах (getOrders)
Возвращает информацию о заказах. Запрос можно использовать, чтобы узнать, нет ли новых заказов.
Доступна фильтрация по нескольким характеристикам заказов:
-
дате оформления;
-
статусу;
-
идентификаторам заказов;
-
этапу обработки или причине отмены;
-
типу (настоящий или тестовый);
-
дате отгрузки в службу доставки;
-
дате и времени обновления заказа.
Информация о заказах, доставленных или отмененных больше 30 дней назад, не возвращается. Ее можно получить с помощью запроса информации об отдельном заказе GET campaigns/{campaignId}/orders/{orderId} (если у вас есть идентификатор заказа) или запроса отчета по заказам POST campaigns/{campaignId}/stats/orders.
Максимальный диапазон дат за один запрос к ресурсу — 30 дней. Максимальное количество заказов в выходных данных запроса — 50.
Результаты возвращаются постранично. Для навигации по страницам используйте параметры page_token и limit.
Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса GET campaigns/{campaignId}/orders/{orderId}/buyer.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
orderIds (optional)
Query Parameter — Фильтрация заказов по идентификаторам.
⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. default: null format: int64
status (optional)
Query Parameter —
Статус заказа:
-
CANCELLED — заказ отменен.
-
DELIVERED — заказ получен покупателем.
-
DELIVERY — заказ передан в службу доставки.
-
PICKUP — заказ доставлен в пункт самовывоза.
-
PROCESSING — заказ находится в обработке.
-
UNPAID — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении).
Также могут возвращаться другие значения. Обрабатывать их не требуется.
default: null
substatus (optional)
Query Parameter —
Этап обработки заказа (если он имеет статус PROCESSING) или причина отмены заказа (если он имеет статус CANCELLED).
Возможные значения для заказа в статусе PROCESSING:
STARTED — заказ подтвержден, его можно начать обрабатывать.READY_TO_SHIP — заказ собран и готов к отправке.SHIPPED — заказ передан службе доставки.
Возможные значения для заказа в статусе CANCELLED:
-
DELIVERY_SERVICE_UNDELIVERED — служба доставки не смогла доставить заказ.
-
PROCESSING_EXPIRED — значение более не используется.
-
REPLACING_ORDER — покупатель решил заменить товар другим по собственной инициативе.
-
RESERVATION_EXPIRED — покупатель не завершил оформление зарезервированного заказа в течение 10 минут.
-
RESERVATION_FAILED — Маркет не может продолжить дальнейшую обработку заказа.
-
SHOP_FAILED — магазин не может выполнить заказ.
-
USER_CHANGED_MIND — покупатель отменил заказ по личным причинам.
-
USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут.
-
USER_REFUSED_DELIVERY — покупателя не устроили условия доставки.
-
USER_REFUSED_PRODUCT — покупателю не подошел товар.
-
USER_REFUSED_QUALITY — покупателя не устроило качество товара.
-
USER_UNREACHABLE — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:
- не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
- перерыв между первым и третьим звонком не менее 90 минут;
- соединение не короче 5 секунд.
Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.
-
USER_WANTS_TO_CHANGE_DELIVERY_DATE — покупатель хочет получить заказ в другой день.
-
CANCELLED_COURIER_NOT_FOUND — не удалось найти курьера.
Также могут возвращаться другие значения. Обрабатывать их не требуется.
default: null
fromDate (optional)
Query Parameter —
Начальная дата для фильтрации заказов по дате оформления.
Формат даты: ДД-ММ-ГГГГ.
Между начальной и конечной датой (параметр toDate) должно быть не больше 30 дней.
Значение по умолчанию: 30 дней назад от текущей даты.
default: null format: date
toDate (optional)
Query Parameter —
Конечная дата для фильтрации заказов по дате оформления.
Показываются заказы, созданные до 00:00 указанного дня.
Формат даты: ДД-ММ-ГГГГ.
Между начальной (параметр fromDate) и конечной датой должно быть не больше 30 дней.
Значение по умолчанию: текущая дата.
default: null format: date
supplierShipmentDateFrom (optional)
Query Parameter —
Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).
Формат даты: ДД-ММ-ГГГГ.
Между начальной и конечной датой (параметр supplierShipmentDateTo) должно быть не больше 30 дней.
Начальная дата включается в интервал для фильтрации.
default: null format: date
supplierShipmentDateTo (optional)
Query Parameter —
Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).
Формат даты: ДД-ММ-ГГГГ.
Между начальной (параметр supplierShipmentDateFrom) и конечной датой должно быть не больше 30 дней.
Конечная дата не включается в интервал для фильтрации.
default: null format: date
updatedAtFrom (optional)
Query Parameter —
Начальная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
Между начальной и конечной датой (параметр updatedAtTo) должно быть не больше 30 дней.
Начальная дата включается в интервал для фильтрации.
default: null format: date-time
updatedAtTo (optional)
Query Parameter —
Конечная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
Между начальной (параметр updatedAtFrom) и конечной датой должно быть не больше 30 дней.
Конечная дата не включается в интервал для фильтрации.
default: null format: date-time
dispatchType (optional)
Query Parameter — Способ отгрузки default: null
fake (optional)
Query Parameter —
Фильтрация заказов по типам:
default: false
hasCis (optional)
Query Parameter —
Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации в системе «Честный ЗНАК»:
Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.
default: false
onlyWaitingForCancellationApprove (optional)
Query Parameter —
Только для модели DBS
Фильтрация заказов по наличию запросов покупателей на отмену.
При значение true возвращаются только заказы, которые находятся в статусе DELIVERY или PICKUP и которые пользователи решили отменить.
Чтобы подтвердить или отклонить отмену, отправьте запрос PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept.
default: false
onlyEstimatedDelivery (optional)
Query Parameter —
Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки:
true — возвращаются только заказы с неподтвержденной датой доставки.false — фильтрация не применяется.
default: false
buyerType (optional)
Query Parameter — Фильтрация заказов по типу покупателя. default: null
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
},
"orders" : [ {
"delivery" : {
"dispatchType" : "UNKNOWN",
"address" : {
"country" : "country",
"city" : "city",
"postcode" : "postcode",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"house" : "house",
"subway" : "subway",
"phone" : "phone",
"street" : "street",
"district" : "district",
"recipient" : "recipient",
"entryphone" : "entryphone",
"block" : "block",
"entrance" : "entrance",
"floor" : "floor",
"apartment" : "apartment"
},
"liftType" : "NOT_NEEDED",
"deliveryServiceId" : 6,
"estimated" : true,
"dates" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022",
"fromTime" : "fromTime",
"toTime" : "toTime",
"realDeliveryDate" : "23-09-2022"
},
"type" : "DELIVERY",
"serviceName" : "serviceName",
"shipments" : [ {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
}, {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
} ],
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ],
"courier" : {
"vehicleDescription" : "vehicleDescription",
"phone" : "phone",
"phoneExtension" : "phoneExtension",
"fullName" : "fullName",
"vehicleNumber" : "vehicleNumber"
},
"price" : 5.025004791520295,
"outletStorageLimitDate" : "23-09-2022",
"eacType" : "MERCHANT_TO_COURIER",
"liftPrice" : 8.762042012749001,
"eacCode" : "eacCode",
"id" : "id",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"deliveryPartnerType" : "SHOP",
"outletCode" : "outletCode"
},
"notes" : "notes",
"substatus" : "RESERVATION_EXPIRED",
"deliveryTotal" : 1.4658129805029452,
"buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
"creationDate" : "23-09-2022 09:12:41",
"buyerItemsTotal" : 5.962133916683182,
"paymentType" : "PREPAID",
"buyer" : {
"lastName" : "lastName",
"firstName" : "firstName",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"expiryDate" : "23-09-2022 09:12:41",
"buyerTotalBeforeDiscount" : 7.061401241503109,
"itemsTotal" : 6.027456183070403,
"buyerTotal" : 5.637376656633329,
"subsidies" : [ {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
} ],
"paymentMethod" : "CASH_ON_DELIVERY",
"currency" : "RUR",
"fake" : true,
"id" : 0,
"taxSystem" : "OSN",
"cancelRequested" : true,
"items" : [ {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
}, {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
} ],
"status" : "PLACING",
"updatedAt" : "23-09-2022 09:12:41"
}, {
"delivery" : {
"dispatchType" : "UNKNOWN",
"address" : {
"country" : "country",
"city" : "city",
"postcode" : "postcode",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"house" : "house",
"subway" : "subway",
"phone" : "phone",
"street" : "street",
"district" : "district",
"recipient" : "recipient",
"entryphone" : "entryphone",
"block" : "block",
"entrance" : "entrance",
"floor" : "floor",
"apartment" : "apartment"
},
"liftType" : "NOT_NEEDED",
"deliveryServiceId" : 6,
"estimated" : true,
"dates" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022",
"fromTime" : "fromTime",
"toTime" : "toTime",
"realDeliveryDate" : "23-09-2022"
},
"type" : "DELIVERY",
"serviceName" : "serviceName",
"shipments" : [ {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
}, {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
} ],
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ],
"courier" : {
"vehicleDescription" : "vehicleDescription",
"phone" : "phone",
"phoneExtension" : "phoneExtension",
"fullName" : "fullName",
"vehicleNumber" : "vehicleNumber"
},
"price" : 5.025004791520295,
"outletStorageLimitDate" : "23-09-2022",
"eacType" : "MERCHANT_TO_COURIER",
"liftPrice" : 8.762042012749001,
"eacCode" : "eacCode",
"id" : "id",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"deliveryPartnerType" : "SHOP",
"outletCode" : "outletCode"
},
"notes" : "notes",
"substatus" : "RESERVATION_EXPIRED",
"deliveryTotal" : 1.4658129805029452,
"buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
"creationDate" : "23-09-2022 09:12:41",
"buyerItemsTotal" : 5.962133916683182,
"paymentType" : "PREPAID",
"buyer" : {
"lastName" : "lastName",
"firstName" : "firstName",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"expiryDate" : "23-09-2022 09:12:41",
"buyerTotalBeforeDiscount" : 7.061401241503109,
"itemsTotal" : 6.027456183070403,
"buyerTotal" : 5.637376656633329,
"subsidies" : [ {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
} ],
"paymentMethod" : "CASH_ON_DELIVERY",
"currency" : "RUR",
"fake" : true,
"id" : 0,
"taxSystem" : "OSN",
"cancelRequested" : true,
"items" : [ {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
}, {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
} ],
"status" : "PLACING",
"updatedAt" : "23-09-2022 09:12:41"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о заказах.
GetOrdersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/stats/orders
Детальная информация по заказам (getOrdersStats)
Возвращает информацию по заказам на Маркете, в которых есть ваши товары. С помощью нее вы можете собрать статистику по вашим заказам и узнать, например, какие из товаров чаще всего возвращаются покупателями, какие, наоборот, пользуются большим спросом, какая комиссия начисляется за заказы и т. п.
{% note info "" %}
Раньше генерация детальной информации по заказам называлась Отчет по заказам. Сейчас это новый отчет. Подробнее об отчете
{% endnote %}
В одном запросе можно получить информацию не более чем по 200 заказам.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"orders" : [ {
"partnerOrderId" : "partnerOrderId",
"commissions" : [ {
"actual" : 1.2315135367772556,
"type" : "FEE"
}, {
"actual" : 1.2315135367772556,
"type" : "FEE"
} ],
"statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
"payments" : [ {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
}, {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
} ],
"fake" : true,
"deliveryRegion" : {
"name" : "name",
"id" : 6
},
"id" : 0,
"creationDate" : "2000-01-23",
"items" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"initialItems" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"status" : "CANCELLED_BEFORE_PROCESSING",
"paymentType" : "CREDIT"
}, {
"partnerOrderId" : "partnerOrderId",
"commissions" : [ {
"actual" : 1.2315135367772556,
"type" : "FEE"
}, {
"actual" : 1.2315135367772556,
"type" : "FEE"
} ],
"statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
"payments" : [ {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
}, {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
} ],
"fake" : true,
"deliveryRegion" : {
"name" : "name",
"id" : 6
},
"id" : 0,
"creationDate" : "2000-01-23",
"items" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"initialItems" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"status" : "CANCELLED_BEFORE_PROCESSING",
"paymentType" : "CREDIT"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация по заказам.
GetOrdersStatsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/outlets/{outletId}
Информация об одной точке продаж (getOutlet)
Возвращает информацию о точках продаж магазина.
В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.
|⚙️ Лимит: 100 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
outletId (required)
Path Parameter — Идентификатор точки продаж. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"outlet" : {
"storagePeriod" : 9,
"address" : {
"number" : "number",
"km" : 6,
"regionId" : 0,
"city" : "city",
"street" : "street",
"additional" : "additional",
"estate" : "estate",
"block" : "block",
"building" : "building"
},
"moderationReason" : "moderationReason",
"visibility" : "HIDDEN",
"isMain" : true,
"phones" : [ "phones", "phones" ],
"workingTime" : "workingTime",
"type" : "DEPOT",
"workingSchedule" : {
"scheduleItems" : [ {
"startDay" : "MONDAY",
"startTime" : "startTime",
"endTime" : "endTime"
}, {
"startDay" : "MONDAY",
"startTime" : "startTime",
"endTime" : "endTime"
} ],
"workInHoliday" : true
},
"shopOutletId" : "shopOutletId",
"shopOutletCode" : "shopOutletCode",
"name" : "name",
"id" : 3,
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"coords" : "coords",
"deliveryRules" : [ {
"priceFreePickup" : 7.061401241503109,
"deliveryServiceId" : 5,
"maxDeliveryDays" : 5,
"minDeliveryDays" : 1,
"orderBefore" : 5,
"unspecifiedDeliveryInterval" : true
}, {
"priceFreePickup" : 7.061401241503109,
"deliveryServiceId" : 5,
"maxDeliveryDays" : 5,
"minDeliveryDays" : 1,
"orderBefore" : 5,
"unspecifiedDeliveryInterval" : true
} ],
"status" : "AT_MODERATION"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о точке продаж.
GetOutletResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/outlets/licenses
Информация о лицензиях для точек продаж (getOutletLicenses)
Возвращает информацию о лицензиях для точек продаж.
В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.
|⚙️ Лимит: 100 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
outletIds (optional)
Query Parameter —
Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.
В запросе должен быть либо параметр outletIds, либо параметр ids. Запрос с обоими параметрами или без них приведет к ошибке.
default: null format: int64
ids (optional)
Query Parameter — Список идентификаторов лицензий. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"licenses" : [ {
"licenseType" : "ALCOHOL",
"number" : "number",
"dateOfExpiry" : "2000-01-23T04:56:07.000+00:00",
"checkStatus" : "NEW",
"outletId" : 6,
"id" : 0,
"dateOfIssue" : "2000-01-23T04:56:07.000+00:00",
"checkComment" : "checkComment"
}, {
"licenseType" : "ALCOHOL",
"number" : "number",
"dateOfExpiry" : "2000-01-23T04:56:07.000+00:00",
"checkStatus" : "NEW",
"outletId" : 6,
"id" : 0,
"dateOfIssue" : "2000-01-23T04:56:07.000+00:00",
"checkComment" : "checkComment"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Найденные лицензии собственных точек продаж.
GetOutletLicensesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/outlets
Информация о нескольких точках продаж (getOutlets)
Возвращает список точек продаж магазина.
В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.
|⚙️ Лимит: 100 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
region_id (optional)
Query Parameter — Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода
GET regions. default: null format: int64
shop_outlet_code (optional)
Query Parameter — Идентификатор точки продаж, присвоенный магазином. default: null
regionId (optional)
Query Parameter —
{% note warning "" %}
Этот параметр устарел. Для указания региона используйте region_id.
{% endnote %}
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
},
"outlets" : [ {
"storagePeriod" : 9,
"address" : {
"number" : "number",
"km" : 6,
"regionId" : 0,
"city" : "city",
"street" : "street",
"additional" : "additional",
"estate" : "estate",
"block" : "block",
"building" : "building"
},
"moderationReason" : "moderationReason",
"visibility" : "HIDDEN",
"isMain" : true,
"phones" : [ "phones", "phones" ],
"workingTime" : "workingTime",
"type" : "DEPOT",
"workingSchedule" : {
"scheduleItems" : [ {
"startDay" : "MONDAY",
"startTime" : "startTime",
"endTime" : "endTime"
}, {
"startDay" : "MONDAY",
"startTime" : "startTime",
"endTime" : "endTime"
} ],
"workInHoliday" : true
},
"shopOutletId" : "shopOutletId",
"shopOutletCode" : "shopOutletCode",
"name" : "name",
"id" : 3,
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"coords" : "coords",
"deliveryRules" : [ {
"priceFreePickup" : 7.061401241503109,
"deliveryServiceId" : 5,
"maxDeliveryDays" : 5,
"minDeliveryDays" : 1,
"orderBefore" : 5,
"unspecifiedDeliveryInterval" : true
}, {
"priceFreePickup" : 7.061401241503109,
"deliveryServiceId" : 5,
"maxDeliveryDays" : 5,
"minDeliveryDays" : 1,
"orderBefore" : 5,
"unspecifiedDeliveryInterval" : true
} ],
"status" : "AT_MODERATION"
}, {
"storagePeriod" : 9,
"address" : {
"number" : "number",
"km" : 6,
"regionId" : 0,
"city" : "city",
"street" : "street",
"additional" : "additional",
"estate" : "estate",
"block" : "block",
"building" : "building"
},
"moderationReason" : "moderationReason",
"visibility" : "HIDDEN",
"isMain" : true,
"phones" : [ "phones", "phones" ],
"workingTime" : "workingTime",
"type" : "DEPOT",
"workingSchedule" : {
"scheduleItems" : [ {
"startDay" : "MONDAY",
"startTime" : "startTime",
"endTime" : "endTime"
}, {
"startDay" : "MONDAY",
"startTime" : "startTime",
"endTime" : "endTime"
} ],
"workInHoliday" : true
},
"shopOutletId" : "shopOutletId",
"shopOutletCode" : "shopOutletCode",
"name" : "name",
"id" : 3,
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"coords" : "coords",
"deliveryRules" : [ {
"priceFreePickup" : 7.061401241503109,
"deliveryServiceId" : 5,
"maxDeliveryDays" : 5,
"minDeliveryDays" : 1,
"orderBefore" : 5,
"unspecifiedDeliveryInterval" : true
}, {
"priceFreePickup" : 7.061401241503109,
"deliveryServiceId" : 5,
"maxDeliveryDays" : 5,
"minDeliveryDays" : 1,
"orderBefore" : 5,
"unspecifiedDeliveryInterval" : true
} ],
"status" : "AT_MODERATION"
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о точках продаж.
GetOutletsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offer-prices
Список цен (getPrices)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST campaigns/{campaignId}/offer-prices.
{% endnote %}
Возвращает список цен, установленных вами на товары любым способом: например, через партнерский API или в файле с каталогом.
{% note info %}
Общее количество товаров считается по данным за последние семь дней (не включая сегодня) и не может быть выше 2 миллионов.
{% endnote %}
Способы установки цен описаны в Справке Маркета для продавцов.
|⚙️ Лимит: (количество товаров партнера на витрине) * 25 товаров в сутки|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
archived (optional)
Query Parameter — Фильтр по нахождению в архиве. default: false
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"marketSku" : 0,
"id" : "id",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"marketSku" : 0,
"id" : "id",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"total" : 6,
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список всех товаров с установленными ценами.
GetPricesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-prices
Просмотр цен на указанные товары в магазине (getPricesByOfferIds)
Возвращает список цен на указанные товары в магазине.
{% note warning "Метод только для отдельных магазинов" %}
Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.
Для просмотра базовых цен используйте POST businesses/{businessId}/offer-mappings.
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"offerId" : "offerId",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"offerId" : "offerId",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров с установленными для заданного магазина ценами.
GetPricesByOfferIdsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos/offers
Получение списка товаров, которые участвуют или могут участвовать в акции (getPromoOffers)
Возвращает список товаров, которые участвуют или могут участвовать в акции.
{% note warning %}
В параметре limit не передавайте значение больше 500.
{% endnote %}
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"offerId" : "offerId",
"params" : {
"discountParams" : {
"promoPrice" : 6,
"maxPromoPrice" : 1,
"price" : 0
},
"promocodeParams" : {
"maxPrice" : 5
}
},
"status" : "AUTO",
"autoParticipatingDetails" : {
"campaignIds" : [ 5, 5 ]
}
}, {
"offerId" : "offerId",
"params" : {
"discountParams" : {
"promoPrice" : 6,
"maxPromoPrice" : 1,
"price" : 0
},
"promocodeParams" : {
"maxPrice" : 5
}
},
"status" : "AUTO",
"autoParticipatingDetails" : {
"campaignIds" : [ 5, 5 ]
}
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров, которые участвуют или могут участвовать в акции.
GetPromoOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos
Получение списка акций (getPromos)
Возвращает информацию об акциях Маркета.
По умолчанию возвращаются акции, в которых продавец участвует или может принять участие.
Чтобы получить текущие или завершенные акции, передайте параметр participation.
Типы акций, которые возвращаются в ответе:
- прямая скидка;
- флеш-акция;
- скидка по промокоду.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"promos" : [ {
"period" : {
"dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
"dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
},
"channels" : [ "{}", "{}" ],
"mechanicsInfo" : {
"promocodeInfo" : {
"promocode" : "promocode",
"discount" : 1
},
"type" : "DIRECT_DISCOUNT"
},
"bestsellerInfo" : {
"bestseller" : true,
"entryDeadline" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "name",
"participating" : true,
"id" : "id",
"constraints" : {
"warehouseIds" : [ 5, 5 ]
},
"assortmentInfo" : {
"activeOffers" : 0,
"processing" : true,
"potentialOffers" : 6
}
}, {
"period" : {
"dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
"dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
},
"channels" : [ "{}", "{}" ],
"mechanicsInfo" : {
"promocodeInfo" : {
"promocode" : "promocode",
"discount" : 1
},
"type" : "DIRECT_DISCOUNT"
},
"bestsellerInfo" : {
"bestseller" : true,
"entryDeadline" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "name",
"participating" : true,
"id" : "id",
"constraints" : {
"warehouseIds" : [ 5, 5 ]
},
"assortmentInfo" : {
"activeOffers" : 0,
"processing" : true,
"potentialOffers" : 6
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список акций Маркета.
GetPromosResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/ratings/quality/details
Заказы, которые повлияли на индекс качества (getQualityRatingDetails)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"affectedOrders" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"orderId" : 0,
"description" : "description"
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"orderId" : 0,
"description" : "description"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о заказах, которые повлияли на индекс качества.
GetQualityRatingDetailsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/ratings/quality
Индекс качества магазинов (getQualityRatings)
Возвращает значение индекса качества магазинов и его составляющие.
Подробнее об индексе качества читайте в Справке Маркета для продавцов.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"campaignRatings" : [ {
"campaignId" : 0,
"ratings" : [ {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
}, {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
} ]
}, {
"campaignId" : 0,
"ratings" : [ {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
}, {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Значение индекса качества магазинов и его составляющие.
GetQualityRatingResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /reports/info/{reportId}
Получение заданного отчета (getReportInfo)
Возвращает статус генерации заданного отчета и, если отчет готов, ссылку для скачивания.
Чтобы воспользоваться этим запросом, вначале нужно запустить генерацию отчета. Инструкция
|⚙️ Лимит: 100 запросов в минуту|
|-|
Path parameters
reportId (required)
Path Parameter — Идентификатор отчета, который вы получили после запуска генерации. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"generationRequestedAt" : "2000-01-23T04:56:07.000+00:00",
"file" : "file",
"generationFinishedAt" : "2000-01-23T04:56:07.000+00:00",
"subStatus" : "NO_DATA",
"status" : "PENDING",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Статус генерации отчета и ссылка, если она уже есть.
{% note tip %}
Если статус генерации отчета — FAILED или NO_DATA, проверьте корректность запроса на генерацию. Например, верно ли указан идентификатор магазина, период или номер платежного поручения.
{% endnote %}
GetReportInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}
Информация о невыкупе или возврате (getReturn)
Получает информацию по одному невыкупу или возврату.
|⚙️ Лимит: 10 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"updateDate" : "2000-01-23T04:56:07.000+00:00",
"fastReturn" : true,
"orderId" : 6,
"shipmentRecipientType" : "SHOP",
"refundStatus" : "STARTED_BY_USER",
"logisticPickupPoint" : {
"logisticPartnerId" : 5,
"address" : {
"country" : "Россия",
"city" : "Москва",
"street" : "Стрелецкая улица",
"postcode" : "123518",
"house" : "9к2"
},
"instruction" : "instruction",
"name" : "name",
"id" : 1,
"type" : "WAREHOUSE"
},
"id" : 0,
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"items" : [ {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
}, {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
} ],
"returnType" : "UNREDEEMED",
"shipmentStatus" : "CREATED",
"refundAmount" : 5
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Детали возврата.
GetReturnResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/application
Получение заявления на возврат (getReturnApplication)
Загружает заявление покупателя на возврат товара.
|⚙️ Лимит: 10 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/octet-streamapplication/json
Responses
200
Заявление на возврат.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}
Получение фотографии возврата (getReturnPhoto)
Получает фотографии, которые покупатель приложил к заявлению на возврат товара.
|⚙️ Лимит: 10 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
itemId (required)
Path Parameter — Идентификатор товара в возврате. default: null format: int64
imageHash (required)
Path Parameter — Хеш ссылки изображения для загрузки. default: null
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/octet-streamapplication/json
Responses
200
Фотография возврата.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/returns
Список невыкупов и возвратов (getReturns)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
orderIds (optional)
Query Parameter —
Идентификаторы заказов — для фильтрации результатов.
Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
default: null format: int64
statuses (optional)
Query Parameter —
Статусы возвратов или невыкупов — для фильтрации результатов.
Несколько статусов перечисляются через запятую.
default: null
type (optional)
Query Parameter —
Тип заказа для фильтрации:
-
RETURN — возврат.
-
UNREDEEMED — невыкуп.
Если не указывать, в ответе будут и возвраты, и невыкупы.
default: null
fromDate (optional)
Query Parameter —
Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
Формат: ГГГГ-ММ-ДД.
default: null format: date
toDate (optional)
Query Parameter —
Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
Формат: ГГГГ-ММ-ДД.
default: null format: date
from_date (optional)
Query Parameter —
{% note warning "" %}
Этот параметр устарел. Вместо него используйте fromDate.
{% endnote %}
Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
default: null format: date
to_date (optional)
Query Parameter —
{% note warning "" %}
Этот параметр устарел. Вместо него используйте toDate.
{% endnote %}
Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
default: null format: date
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"nextPageToken" : "nextPageToken"
},
"returns" : [ {
"updateDate" : "2000-01-23T04:56:07.000+00:00",
"fastReturn" : true,
"orderId" : 6,
"shipmentRecipientType" : "SHOP",
"refundStatus" : "STARTED_BY_USER",
"logisticPickupPoint" : {
"logisticPartnerId" : 5,
"address" : {
"country" : "Россия",
"city" : "Москва",
"street" : "Стрелецкая улица",
"postcode" : "123518",
"house" : "9к2"
},
"instruction" : "instruction",
"name" : "name",
"id" : 1,
"type" : "WAREHOUSE"
},
"id" : 0,
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"items" : [ {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
}, {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
} ],
"returnType" : "UNREDEEMED",
"shipmentStatus" : "CREATED",
"refundAmount" : 5
}, {
"updateDate" : "2000-01-23T04:56:07.000+00:00",
"fastReturn" : true,
"orderId" : 6,
"shipmentRecipientType" : "SHOP",
"refundStatus" : "STARTED_BY_USER",
"logisticPickupPoint" : {
"logisticPartnerId" : 5,
"address" : {
"country" : "Россия",
"city" : "Москва",
"street" : "Стрелецкая улица",
"postcode" : "123518",
"house" : "9к2"
},
"instruction" : "instruction",
"name" : "name",
"id" : 1,
"type" : "WAREHOUSE"
},
"id" : 0,
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"items" : [ {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
}, {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
} ],
"returnType" : "UNREDEEMED",
"shipmentStatus" : "CREATED",
"refundAmount" : 5
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Постраничные возвраты партнера.
GetReturnsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers/stocks
Информация об остатках и оборачиваемости (getStocks)
Возвращает данные об остатках товаров (для всех моделей) и об оборачиваемости товаров (для модели FBY).
{% note info "По умолчанию данные по оборачивамости не возращаются" %}
Чтобы они были в ответе, передавайте true в поле withTurnover.
{% endnote %}
|⚙️ Лимит: 100 000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"warehouses" : [ {
"offers" : [ {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"warehouseId" : 0
}, {
"offers" : [ {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"warehouseId" : 0
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Остатки товаров на складах.
GetWarehouseStocksResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-mapping-entries/suggestions
Рекомендованные карточки для товаров (getSuggestedOfferMappingEntries)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/suggestions.
{% endnote %}
Возвращает идентификаторы карточек товаров на Маркете, рекомендованных для ваших товаров.
Каждому товару, который вы размещаете, должна соответствовать карточка товара на Маркете со своим идентификатором — SKU на Маркете. Он указывается в URL карточки товара, после «...sku=», например:
##https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016…##
Чтобы получить для товаров рекомендованные SKU на Маркете, передайте в теле POST-запроса как можно больше информации о них: названия, производителей, штрихкоды, цены и т. д.
Полученные SKU можно передать вместе с информацией о ваших товарах с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/updates.
В одном запросе можно получить не более 500 рекомендаций.
|⚙️ Лимит: 100 000 рекомендаций в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"marketCategoryId" : 4,
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"marketModelId" : 7,
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"marketSkuName" : "marketSkuName",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"marketModelName" : "marketModelName",
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"marketCategoryName" : "marketCategoryName",
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
}, {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"marketCategoryId" : 4,
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"marketModelId" : 7,
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"marketSkuName" : "marketSkuName",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"marketModelName" : "marketModelName",
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"marketCategoryName" : "marketCategoryName",
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о товарах в каталоге.
GetSuggestedOfferMappingEntriesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/suggestions
Просмотр карточек на Маркете, которые подходят вашим товарам (getSuggestedOfferMappings)
Возвращает идентификаторы карточек на Маркете, которые соответствуют товарам с заданными параметрами.
Пользоваться этим запросом необязательно: он просто помогает заранее убедиться, что Маркет верно определяет карточки по предоставленным вами данным.
Как пользоваться запросом
- Передайте Маркету список товаров, которые нужно проверить.
- В ответ вы получите список SKU на Маркете с расшифровкой: названием, идентификатором модели, категорией.
- Если расшифровки мало, вы можете открыть карточку. Для этого перейдите по ссылке вида
https://market.yandex.ru/product/<marketModelId>?sku=<marketSku>.
- Если карточка соответствует товару, значит его можно добавлять в каталог с теми данными, что вы указали. Если карточка определилась неправильно — проверьте данные о товаре. Возможно, их нужно уточнить или дополнить. Кроме того, на этапе добавления товара вы можете указать
marketSKU, который ему подходит по вашему мнению.
{% note info "𝓠 Как определить marketSku товара, найденного на Маркете?" %}
𝓐 Он есть в адресе страницы товара — расположен после sku=.
Например, https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016
{% endnote %}
|⚙️ Лимит: 100 000 товаров в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"offer" : {
"vendor" : "LEVENHUK",
"basicPrice" : {
"value" : 0.9301444243932576
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"description" : "description",
"category" : "category",
"barcodes" : [ "46012300000000", "46012300000000" ],
"vendorCode" : "VNDR-0005A"
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
}, {
"offer" : {
"vendor" : "LEVENHUK",
"basicPrice" : {
"value" : 0.9301444243932576
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"description" : "description",
"category" : "category",
"barcodes" : [ "46012300000000", "46012300000000" ],
"vendorCode" : "VNDR-0005A"
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Подобранные карточки на Маркете.
По результатам проверки товара полученная через этот запрос карточка может быть заменена на другую.
GetSuggestedOfferMappingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-prices/suggestions
Цены для продвижения товаров (getSuggestedPrices)
{% note warning "" %}
Этот метод устарел. Вместо него используйте отчет «Цены на рынке».
{% endnote %}
{% note warning "" %}
Этот метод подходит только тем магазинам, которые устанавливают цены на товары в рублях.
{% endnote %}
Возвращает цены для продвижения товаров, которые вы размещаете на Маркете.
Товары, для которых нужно получить цены, передаются в теле POST-запроса.
Цены для продвижения зависят от цен, установленных на товары другими партнерами. Если один товар поставляют несколько партнеров, на Маркете сначала продается товар с более низкой ценой. Когда закончится товар по низкой цене, начнет продаваться товар по более высокой цене.
Выходные данные содержат для каждого товара несколько цен, соответствующих разным типам продвижения.
Установить цены на товары можно с помощью запроса POST campaigns/{campaignId}/offer-prices/updates или другими способами: например, указать их в файле с каталогом. Также вы можете использовать стратегии для автоматической установки рекомендованных цен или минимальных цен на Маркете.
Подробно об автоматическом управлении ценами рассказано в Справке Маркета для продавцов.
|⚙️ Лимит: 100 000 товаров в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"marketSku" : 0,
"offerId" : "offerId",
"priceSuggestion" : [ {
"price" : 6.027456183070403,
"type" : "BUYBOX"
}, {
"price" : 6.027456183070403,
"type" : "BUYBOX"
} ]
}, {
"marketSku" : 0,
"offerId" : "offerId",
"priceSuggestion" : [ {
"price" : 6.027456183070403,
"type" : "BUYBOX"
}, {
"price" : 6.027456183070403,
"type" : "BUYBOX"
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список цен для продвижения на Маркете.
SuggestPricesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /businesses/{businessId}/warehouses
Список складов и групп складов (getWarehouses)
Возвращает список складов и, если склады объединены, список групп складов. Что такое группы складов и зачем они нужны
Среди прочего запрос позволяет определить идентификатор, который нужно использовать при передаче остатков для группы складов.
|⚙️ Лимит: 100 запросов в минуту|
|-|
Path parameters
Return type
Example data
Content-Type: application/json
{
"result" : {
"warehouses" : [ {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}, {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
} ],
"warehouseGroups" : [ {
"name" : "name",
"warehouses" : [ {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}, {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
} ],
"mainWarehouse" : {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}
}, {
"name" : "name",
"warehouses" : [ {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}, {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
} ],
"mainWarehouse" : {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список складов и групп складов.
GetWarehousesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/{orderId}/deliverDigitalGoods
Передача ключей цифровых товаров (provideOrderDigitalCodes)
Передает ключи цифровых товаров, которые покупатель заказал и оплатил. После выполнения запроса Маркет отправит ему письмо с ключами и инструкциями по активации, а также переведет заказ в финальный статус DELIVERED.
Ключ нужно передать в течение 30 минут после перехода заказа в статус PROCESSING.
Если в один заказ входят несколько ключей, передавайте их все в одном запросе.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/identifiers
Передача кодов маркировки единиц товара (provideOrderItemIdentifiers)
{% note warning "Этот запрос только для DBS" %}
Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.
{% endnote %}
Передает Маркету коды маркировки для единиц товара в указанном заказе.
Принимаются коды следующих типов:
- Коды «Честного знака».
- УИН для ювелирных изделий.
- РНПТ и ГТД для импортных прослеживаемых товаров.
{% note warning %}
Прежде чем работать с этим методом, обязательно прочтите статью о работе с маркируемыми товарами.
{% endnote %}
Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"items" : [ {
"offerName" : "offerName",
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"price" : 1.4658129805029452,
"vat" : "NO_VAT",
"count" : 6,
"offerId" : "offerId",
"id" : 0
}, {
"offerName" : "offerName",
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"price" : 1.4658129805029452,
"vat" : "NO_VAT",
"count" : 6,
"offerId" : "offerId",
"id" : 0
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ 200 обозначает, что коды успешно записались. Ответ содержит краткие сведения о промаркированных товарах.
ProvideOrderItemIdentifiersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /businesses/{businessId}/bids
Включение буста продаж и установка ставок (putBidsForBusiness)
Запускает буст продаж — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.
{% cut "Как в кабинете выглядит кампания, созданная через API" %}
{% endcut %}
При первом использовании запроса Маркет: создаст единую на все магазины бизнес-аккаунта кампанию, добавит в нее товары с указанными ставками, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.
Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.
Запрос всегда работает с одной и той же созданной через API кампанией. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. Другими кампаниями управлять через API не получится. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.
Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.
Внести другие изменения в созданную через API кампанию можно в кабинете:
- выключить или включить кампанию;
- изменить ее название;
- выключить или включить ценовую стратегию.
Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.
Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.
{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}
𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.
{% endnote %}
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Все получилось: ставки установлены или обновлены. Если нужно, добавлены новые товары и запущена кампания.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/bids
Включение буста продаж и установка ставок для магазина (putBidsForCampaign)
Запускает буст продаж в указанном магазине — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.
При первом использовании запроса Маркет: создаст кампанию, добавит в нее товары с указанными ставками для заданного магазина, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.
Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.
Запрос всегда работает с одной и той же кампанией, созданной через этот запрос или PUT businesses/{businessId}/bids. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.
Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.
Внести другие изменения в созданную через API кампанию можно в кабинете:
- выключить или включить кампанию;
- изменить ее название;
- выключить или включить ценовую стратегию.
Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.
Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.
{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}
𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.
{% endnote %}
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/feeds/{feedId}/refresh
Сообщить, что прайс-лист обновился (refreshFeed)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет сообщить, что магазин обновил прайс-лист. После этого Маркет начнет обновление данных на сервисе.
- Магазин обновляет прайс-лист, ссылку на который он указал в кабинете.
- Магазин отправляет Маркету запрос методом
POST campaigns/{campaignId}/feeds/{feedId}/refresh.
- Маркет начинает обновление данных магазина на сервисе.
{% note alert %}
Запрос работает только для включенных магазинов. Если магазин выключен, данные на Маркете не обновятся, даже если HTTP-код — 200 OK. Проверить статус магазина можно с помощью базовых запросов или на странице бизнес-аккаунта.
{% endnote %}
|⚙️ Лимит: 3 запроса в час для одного прайс-листа|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Поиск модели товара (searchModels)
Возвращает информацию о моделях, удовлетворяющих заданным в запросе условиям поиска.
В одном запросе можно получить информацию не более чем о 100 моделях.
Для методов GET models, GET models/{modelId} и POST models действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.
|⚙️ Лимит: рассчитывается индивидуально|
|-|
Query parameters
query (required)
Query Parameter — Поисковый запрос по названию модели товара. default: null
regionId (required)
Query Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
currency (optional)
Query Parameter —
Валюта, в которой отображаются цены предложений на страницах с результатами поиска.
Возможные значения:
Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
default: null
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"models" : [ {
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
}
}, {
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
}
} ],
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
},
"regionId" : 5,
"currency" : "RUR"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о моделях.
SearchModelsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /regions/{regionId}/children
Информация о дочерних регионах (searchRegionChildren)
Возвращает информацию о регионах, являющихся дочерними по отношению к региону, идентификатор которого указан в запросе.
Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).
Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.
|⚙️ Лимит: 50 000 запросов в час|
|-|
Path parameters
regionId (required)
Path Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
Query parameters
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"regions" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Регионы, являющиеся дочерними к указанному в запросе.
GetRegionWithChildrenResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /regions/{regionId}
Информация о регионе (searchRegionsById)
Возвращает информацию о регионе.
Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).
Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.
|⚙️ Лимит: 50 000 запросов в час|
|-|
Path parameters
regionId (required)
Path Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"regions" : [ {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}, {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Найденный регион.
GetRegionsResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Поиск регионов по их имени (searchRegionsByName)
Возвращает информацию о регионе, удовлетворяющем заданным в запросе условиям поиска.
Если найдено несколько регионов, удовлетворяющих условиям поиска, возвращается информация по каждому найденному региону (но не более десяти регионов) для возможности определения нужного региона по родительским регионам.
Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).
Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.
|⚙️ Лимит: 50 000 запросов в час|
|-|
Query parameters
name (required)
Query Parameter —
Название региона.
Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, Москва.
default: null
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"regions" : [ {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}, {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список найденных регионов.
GetRegionsResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/file/send
Отправка файла в чат (sendFileToChat)
Отправляет файл в чат с покупателем.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Query parameters
chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
Form parameters
file (required)
Form Parameter — Содержимое файла. Максимальный размер файла — 5 Мбайт. default: null format: binary
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ. Означает, что файл отправлен.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/message
Отправка сообщения в чат (sendMessageToChat)
Отправляет сообщение в чат с покупателем.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ. Означает, что сообщение отправлено.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/feeds/{feedId}/params
Изменение параметров прайс-листа (setFeedParams)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет магазину изменить параметры прайс-листа.
Чтобы отредактировать параметр прайс-листа, передайте в теле запроса: name (название параметра) и value (значение параметра).
Чтобы отменить установленное значение, передайте в теле запроса: name (название параметра) и delete=true (удалить значение).
|⚙️ Лимит: 3 запроса в час для одного прайс-листа|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Статус выполнения операции.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/boxes
Подготовка заказа (setOrderBoxLayout)
{% note tip "Подходит и для DBS" %}
Запрос предназначен для работы с FBS-заказами, но вы можете использовать его для обработки DBS-заказов, если это удобно.
{% endnote %}
Позволяет выполнить три операции:
- передать Маркету информацию о распределении товаров по коробкам;
- передать Маркету коды маркировки для товаров;
- удалить товар из заказа, если его не оказалось на складе.
Если нужно что-то поправить в переданных данных, просто повторите запрос — это можно делать сколько угодно раз до перевода заказа в статус Готов к отгрузке. ⚠️ Если вы меняете раскладку уже после печати и расклейки ярлыков, не забудье перепечатать их и наклеить заново.
Как передать информацию о распределении товаров
В этом запросе вам нужно передать Маркету список коробок и указать, какие именно товары лежат в каждой из них. Коробки могут быть двух типов:
-
Содержащие товары целиком. Такая коробка может содержать сколько угодно единиц любых товаров.
-
Содержащие часть товара. Такие коробки содержат по одной части одного товара. Например, одна содержит внешний блок кондиционера, а другая — внутренний блок.
⚠️ Одна коробка не может содержать и товары целиком, и части товаров.
Как передавать коды маркировки
Если в заказе есть товары, подлежащие маркировке, в запросе нужно передать соответствующие уникальные коды. Что такое маркировка?
Принимаются коды следующих типов:
- Коды «Честного знака».
- УИН для ювелирных изделий.
- РНПТ и ГТД для импортных прослеживаемых товаров.
Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй.
Если товар едет в нескольких коробках, код маркировки нужно передать для каждой из них.
Как удалить товар из заказа
Чтобы удалить товар из заказа:
- Добавьте в запрос
allowRemove: true.
- Передайте распределение по коробкам без товара, который нужно удалить.
{% note warning "Удаление нельзя отменить" %}
Эта операция необратима: покупатель сразу получит уведомление, а состав заказа изменится.
{% endnote %}
Чтобы удалить позицию целиком, не передавайте соответствующий OrderBoxLayoutItemDTO. Чтобы уменьшить количество товара, передайте уменьшенное значение в поле fullCount.
Нельзя удалить или уменьшить количество товара, если он:
- добавлен по акции;
- составляет 99% стоимости заказа;
- единственный товар в заказе.
Если вы не можете отгрузить такой товар, отмените заказ. Для этого отправьте запрос методом PUT campaigns/{campaignId}/orders/{orderId}/status и передайте статус заказа CANCELLED с причиной отмены SHOP_FAILED.
{% note info "Увеличить заказ нельзя" %}
С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим.
{% endnote %}
Примеры
{% cut "Товар умещается в коробку" %}
Вот как будет выглядеть запрос, если в одной коробке едут:
- три единицы одного товара, требующего маркировки;
- одна единица другого товара, не требущего маркировки.
{
"boxes": [
{
"items": [
{
"id": 123456,
"fullCount": 3,
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
},
{
"cis": "010304109478gftJ14545762!\u001dhGt264"
},
{
"cis": "010304109478fRs28323ks23!\u001dhet201"
}
]
},
{
"id": 654321,
"fullCount": 1
}
]
}
]
}
{% endcut %}
{% cut "Товар едет в разных коробках" %}
Вот как будет выглядеть запрос, если товар едет в двух коробках:
{
"boxes": [
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 2,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
}
]
}
{% endcut %}
{% cut "Одинаковые товары, где каждый едет в нескольких коробках" %}
Вот как будет выглядеть запрос, если каждый из двух одинаковых товаров едет в двух коробках:
{
"boxes": [
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 2,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 2,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
}
]
}
{% endcut %}
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"boxes" : [ {
"items" : [ {
"partialCount" : {
"current" : 1,
"total" : 2
},
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
} ],
"id" : 0,
"fullCount" : 1
}, {
"partialCount" : {
"current" : 1,
"total" : 2
},
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
} ],
"id" : 0,
"fullCount" : 1
} ],
"boxId" : 5
}, {
"items" : [ {
"partialCount" : {
"current" : 1,
"total" : 2
},
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
} ],
"id" : 0,
"fullCount" : 1
}, {
"partialCount" : {
"current" : 1,
"total" : 2
},
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
} ],
"id" : 0,
"fullCount" : 1
} ],
"boxId" : 5
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ придет переданная раскладка с идентификаторами коробок — они понадобятся для запроса ярлыков.
SetOrderBoxLayoutResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/delivery/date
Изменение даты доставки заказа (setOrderDeliveryDate)
Метод изменяет дату доставки заказа в статусе PROCESSING или DELIVERY. Для заказов с другими статусами дату доставки изменить нельзя.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Успешное изменение даты доставки.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/{orderId}/delivery/track
Передача трек‑номера посылки (setOrderDeliveryTrackCode)
{% note warning "Этот запрос только для DBS" %}
Вы можете использовать запрос, чтобы повысить лояльность покупателей. Если они могут узнать, на каком этапе доставки находятся их заказы, доверие покупателей к вашему магазину может возрасти.
{% endnote %}
Передает Маркету трек‑номер, по которому покупатель может отследить посылку со своим заказом через службу доставки.
Передать трек‑номер можно, только если заказ находится в статусе PROCESSING, DELIVERY или PICKUP.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Трек‑номер посылки и идентификатор службы доставки были успешно переданы.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes
Передача количества грузовых мест в заказе (setOrderShipmentBoxes)
{% note warning "Этот запрос только для DBS" %}
Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.
{% endnote %}
Отгружаемый Маркету заказ может не влезть в одну коробку или упаковку — в этом случае получается, что он занимает несколько грузовых мест.
Количество грузовых мест нужно обязательно передавать Маркету, если оно не равно 1. Это делается перед переводом его в статус Готов к отгрузке. Подробно о том, что в какой момент нужно передавать, рассказано в пошаговой инструкции.
Метод устроен немного нестандартно: количество задается длиной массива пустых объектов.
Раньше метод требовал передачи большего количества данных. Запросы, оформленные по старому образцу, работают, но лучше делать по-новому.
{% cut "Как было раньше" %}
Структура тела PUT-запроса:
{
"boxes":
[
{
"fulfilmentId": "{string}",
"weight": {int64},
"width": {int64},
"height": {int64},
"depth": {int64},
"items":
[
{
"id": {int64},
"count": {int32}
},
...
]
},
...
]
}
| Параметр | Тип | Значение |
| ----------- | ----------- | ----------- |
| boxes | | Список грузовых мест. |
Параметры, вложенные в boxes
| Параметр | Тип | Значение |
| ----------- | ----------- | ----------- |
| fulfilmentId | String | Идентификатор грузового места в информационной системе магазина. Сформируйте идентификатор по шаблону: номер заказа на Маркете-номер грузового места. Например, 7206821‑1, 7206821‑2 и т. д. |
| weight | Int64 | Масса брутто грузового места (суммарная масса упаковки и содержимого) в граммах. |
| width | Int64 | Ширина грузового места в сантиметрах. |
| height | Int64 | Высота грузового места в сантиметрах. |
| depth | Int64 | Глубина грузового места в сантиметрах. |
| items | Int64 | Список товаров в грузовом месте. |
Параметры, вложенные в items
| Параметр | Тип | Значение |
| ----------- | ----------- | ----------- |
| id | Int64 | Идентификатор товара в рамках заказа. |
| count | Int32 | Количество единиц товара в грузовом месте. |
{% endcut %}
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
shipmentId (required)
Path Parameter — Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 0
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 0
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Имеет значение только тип ответа. Если ответ
ОК, количество грузомест записано.
SetOrderShipmentBoxesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision
Принятие или изменение решения по возврату (setReturnDecision)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Детали возврата.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/skip-reaction
Отказ от ответа на отзывы (skipGoodsFeedbacksReaction)
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/submit
Подтверждение решения по возврату (submitReturnDecision)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Статус выполнения операции.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-prices/updates
Установка цен на товары во всех магазинах (updateBusinessPrices)
Устанавливает базовые цены. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Маркет принял информацию о новых ценах.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers/update
Изменение условий продажи товаров в магазине (updateCampaignOffers)
Изменяет параметры продажи товаров в конкретном магазине: доступность товара, условия доставки и самовывоза, применяемую ставку НДС.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ 200 обозначает, что новые параметры получены Маркетом и скоро вступят в силу.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/comments/update
Добавление нового или изменение созданного комментария (updateGoodsFeedbackComment)
Добавляет новый комментарий магазина или изменяет комментарий, который магазин оставлял ранее.
Для создания комментария к отзыву передайте только идентификатор отзыва feedbackId.
Чтобы добавить комментарий к другому комментарию, передайте:
feedbackId — идентификатор отзыва;comment.parentId — идентификатор родительского комментария.
Чтобы изменить комментарий, передайте:
feedbackId— идентификатор отзыва;comment.id — идентификатор комментария, который нужно изменить.
Если передать одновременно comment.parentId и comment.id, будет изменен существующий комментарий.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 0,
"text" : "text",
"canModify" : true,
"parentId" : 6,
"status" : "PUBLISHED"
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о добавленном или измененном комментарии.
UpdateGoodsFeedbackCommentResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-cards/update
Редактирование категорийных характеристик товара (updateOfferContent)
Редактирует характеристики товара, которые специфичны для категории, к которой он относится.
{% note warning "Здесь только то, что относится к конкретной категории" %}
Если вам нужно изменить основные параметры товара (название, описание, изображения, видео, производитель, штрихкод), воспользуйтесь запросом POST businesses/{businessId}/offer-mappings/update.
{% endnote %}
Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"results" : [ {
"warnings" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ]
}, {
"warnings" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ]
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Запрос выполнен корректно, данные обработаны.
{% note warning "Ответ 200 сам по себе не значит, что переданные значения корректны" %}
Обязательно посмотрите детали ответа: status и перечень ошибок, если он есть.
Даже если ошибка допущена в характеристиках всего одного товара, никакие изменения из запроса в каталог не попадут.
{% endnote %}
Если в status вернулось ERROR, убедитесь, что:
- все обязательные характеристики заполнены;
- характеристики действительно существуют в указанных категориях;
- значения соответствуют характеристикам;
- ваши собственные значения имеют нужный тип данных.
Найти проблемы помогут поля errors и warnings.
UpdateOfferContentResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-mapping-entries/updates
Добавление и редактирование товаров в каталоге (updateOfferMappingEntries)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/update.
{% endnote %}
Добавляет товары, указанные в запросе, в ваш каталог товаров и редактирует уже имеющиеся товары.
Информацию о товарах нужно передать в теле POST-запроса.
У каждого товара должен быть ваш SKU — уникальный код, который вы используете для идентификации товара:
- Чтобы добавить в каталог новый товар, укажите в параметре
shopSku ваш SKU, которого еще нет в каталоге.
- Чтобы отредактировать товар из каталога, укажите в параметре
shopSku ваш SKU этого товара в каталоге.
В обоих случаях в запросе нужно передать полное описание товара, даже если вы хотите изменить только несколько характеристик.
Если вы знаете, какой карточке товара на Маркете соответствует ваш товар, укажите ее идентификатор (SKU на Маркете) во входном параметре mapping. Получить SKU на Маркете рекомендованной карточки товара можно с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/suggestions или через кабинет. Если SKU на Маркете не указан, сотрудники Маркета сами подберут или создадут подходящую карточку товара, либо у него появится статус NEED_CONTENT (нужно найти карточку или создать ее самостоятельно) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.
Перед публикацией товары проходят модерацию. Если в одном из отправленных товаров найдена ошибка, ответ на запрос будет иметь HTTP-код 400 Bad Request, и ни один из товаров не отправится на модерацию. При этом если вы не передадите все обязательные параметры для какого‑либо товара, после модерации у него появится статус NEED_INFO (в описании товара не хватает информации) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.
В одном запросе можно добавить не более 500 товаров.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5 000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Статус выполнения операции.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/update
Добавление товаров в каталог и изменение информации о них (updateOfferMappings)
Добавляет товары в каталог, передает их категории на Маркете и характеристики, необходимые для этих категории. Также редактирует информацию об уже имеющихся товарах.
Список категорий Маркета можно получить с помощью запроса POST categories/tree, а характеристики товаров по категориям с помощью POST category/{categoryId}/parameters.
Чтобы добавить новый товар, передайте его с новым идентификатором, который раньше никогда не использовался в каталоге. Старайтесь сразу передать как можно больше информации — она потребуется Маркету для подбора подходящей карточки или создания новой. Если известно, какой карточке на Маркете соответствует товар, можно сразу указать идентификатор этой карточки (SKU на Маркете) в поле marketSKU.
Для новых товаров обязательно укажите параметры: offerId, name, marketCategoryId или category, pictures, vendor, description.
Чтобы отредактировать информацию о товаре, передайте новые данные, указав в offerId соответствующий ваш SKU. Поля, в которых ничего не меняется, можно не передавать.
Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.
Параметр offerId должен быть уникальным для всех товаров, которые вы передаете.
{% note warning "Правила использования SKU" %}
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
{% endnote %}
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"results" : [ {
"warnings" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ]
}, {
"warnings" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ]
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Все обязательные поля товаров заполнены, поэтому новые товары и внесенные изменения сохранены в каталоге.
UpdateOfferMappingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/items
Удаление товара из заказа или уменьшение числа единиц (updateOrderItems)
{% note warning "Этот запрос только для DBS" %}
Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.
{% endnote %}
Изменяет состав заказа, если позволяет выбранная служба доставки, в случаях:
- покупатель уменьшил количество товара;
- магазин не может поставить все товары в заказе.
Для этого заказ должен находится в статусе "status": "PROCESSING" этапа обработки "substatus": "STARTED". После передачи статуса "substatus": "READY_TO_SHIP" изменить состав невозможно.
Если одинаковых товаров несколько, для уменьшения количества передайте обновленное значение в атрибуте count параметра item.
Чтобы полностью удалить товар из заказа:
- передайте значение
0; или
- не передавайте параметр
item.
Нельзя удалить или уменьшить количество товара, если он:
- добавлен по акции;
- составляет 99% стоимости заказа;
- единственный товар в заказе.
Если необходимо удалить такой товар, отмените заказ. Для этого отправьте запрос методом PUT campaigns/{campaignId}/orders/{orderId}/status и передайте статус заказа CANCELLED с причиной отмены SHOP_FAILED.
{% note info "Увеличить заказ нельзя" %}
С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим.
{% endnote %}
Возврат денег покупателю
Если покупатель оплатил товар при оформлении, Маркет вернет ему деньги за удаленные из заказа товары в течение двух дней:
-
при оплате банковской картой — с момента, когда магазин переведет заказ в статус SHIPPED;
-
при оплате через Apple Pay или Google Pay — с момента, когда магазин удалит товар из заказа.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Маркет успешно обработал ваш запрос. Выходные данные не ожидаются.
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/status
Изменение статуса одного заказа (updateOrderStatus)
Изменяет статус заказа. Возможные изменения статусов:
- Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "STARTED" нужно перевести в статус "status": "PROCESSING" и этап обработки "substatus": "READY_TO_SHIP".
- Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "STARTED" нужно перевести в статус "status": "CANCELLED" с причиной отмены заказа "substatus": "SHOP_FAILED".
- Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "READY_TO_SHIP" нужно перевести в статус "status": "CANCELLED" с причиной отмены заказа "substatus": "SHOP_FAILED".
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"order" : {
"delivery" : {
"dispatchType" : "UNKNOWN",
"address" : {
"country" : "country",
"city" : "city",
"postcode" : "postcode",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"house" : "house",
"subway" : "subway",
"phone" : "phone",
"street" : "street",
"district" : "district",
"recipient" : "recipient",
"entryphone" : "entryphone",
"block" : "block",
"entrance" : "entrance",
"floor" : "floor",
"apartment" : "apartment"
},
"liftType" : "NOT_NEEDED",
"deliveryServiceId" : 6,
"estimated" : true,
"dates" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022",
"fromTime" : "fromTime",
"toTime" : "toTime",
"realDeliveryDate" : "23-09-2022"
},
"type" : "DELIVERY",
"serviceName" : "serviceName",
"shipments" : [ {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
}, {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
} ],
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ],
"courier" : {
"vehicleDescription" : "vehicleDescription",
"phone" : "phone",
"phoneExtension" : "phoneExtension",
"fullName" : "fullName",
"vehicleNumber" : "vehicleNumber"
},
"price" : 5.025004791520295,
"outletStorageLimitDate" : "23-09-2022",
"eacType" : "MERCHANT_TO_COURIER",
"liftPrice" : 8.762042012749001,
"eacCode" : "eacCode",
"id" : "id",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"deliveryPartnerType" : "SHOP",
"outletCode" : "outletCode"
},
"notes" : "notes",
"substatus" : "RESERVATION_EXPIRED",
"deliveryTotal" : 1.4658129805029452,
"buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
"creationDate" : "23-09-2022 09:12:41",
"buyerItemsTotal" : 5.962133916683182,
"paymentType" : "PREPAID",
"buyer" : {
"lastName" : "lastName",
"firstName" : "firstName",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"expiryDate" : "23-09-2022 09:12:41",
"buyerTotalBeforeDiscount" : 7.061401241503109,
"itemsTotal" : 6.027456183070403,
"buyerTotal" : 5.637376656633329,
"subsidies" : [ {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
} ],
"paymentMethod" : "CASH_ON_DELIVERY",
"currency" : "RUR",
"fake" : true,
"id" : 0,
"taxSystem" : "OSN",
"cancelRequested" : true,
"items" : [ {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
}, {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
} ],
"status" : "PLACING",
"updatedAt" : "23-09-2022 09:12:41"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В случае успешного изменения статуса заказа возвращается обновленная информация о заказе.
UpdateOrderStatusResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/status-update
Изменение статусов нескольких заказов (updateOrderStatuses)
Изменяет статусы нескольких заказов.
Возможные изменения статусов:
- Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса
"status": "PROCESSING"и этапа обработки "substatus": "STARTED" нужно перевести в статус "status": "PROCESSING" и этап обработки "substatus": "READY_TO_SHIP".
- Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "STARTED" нужно перевести в статус "status": "CANCELLED" с причиной отмены заказа "substatus": "SHOP_FAILED".
- Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "READY_TO_SHIP" нужно перевести в статус "status": "CANCELLED" с причиной отмены заказа "substatus": "SHOP_FAILED".
Максимальное количество заказов, у которых можно изменить статус в одном запросе, — 30.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"orders" : [ {
"substatus" : "RESERVATION_EXPIRED",
"updateStatus" : "OK",
"id" : 0,
"status" : "PLACING",
"errorDetails" : "errorDetails"
}, {
"substatus" : "RESERVATION_EXPIRED",
"updateStatus" : "OK",
"id" : 0,
"status" : "PLACING",
"errorDetails" : "errorDetails"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Возвращается информация об обновленных статусах заказов.
UpdateOrderStatusesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/delivery/storage-limit
Продление срока хранения заказа (updateOrderStorageLimit)
Продлевает срок хранения заказа в пункте выдачи продавца.
Заказ должен быть в статусе PICKUP. Продлить срок можно только один раз, не больше чем на 30 дней.
Новый срок хранения можно получить в параметре outletStorageLimitDate запроса GET campaigns/{campaignId}/orders/{orderId}.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/outlets/{outletId}
Изменение информации о точке продаж (updateOutlet)
Изменяет информацию о точке продаж магазина на Маркете.
В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.
|⚙️ Лимит: 100 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
outletId (required)
Path Parameter — Идентификатор точки продаж. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/outlets/licenses
Создание и изменение лицензий для точек продаж (updateOutletLicenses)
Передает информацию о новых и существующих лицензиях для точек продаж. Поддерживаются только лицензии на розничную продажу алкоголя.
Чтобы размещать алкогольную продукцию на Маркете, надо также прислать гарантийное письмо (если вы еще не делали этого раньше) и правильно оформить предложения в прайс-листе. Далее информация о лицензиях проходит проверку.
В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.
|⚙️ Лимит: 100 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-prices/updates
Установка цен на товары в конкретном магазине (updatePrices)
Устанавливает цены на товары в магазине. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.
{% note warning "Метод только для отдельных магазинов" %}
Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.
Для управления базовыми ценами используйте POST businesses/{businessId}/offer-prices/updates.
{% endnote %}
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Маркет принял информацию о новых ценах.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos/offers/update
Добавление товаров в акцию или изменение их цен (updatePromoOffers)
Добавляет товары в акцию или изменяет цены на товары, которые участвуют в акции.
Изменения начинают действовать в течение 4–6 часов.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"rejectedOffers" : [ {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
}, {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
} ],
"warningOffers" : [ {
"warnings" : [ {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
}, {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
} ],
"offerId" : "offerId"
}, {
"warnings" : [ {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
}, {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
} ],
"offerId" : "offerId"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Результат добавления товаров в акцию или обновления их цен.
UpdatePromoOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/offers/stocks
Передача информации об остатках (updateStocks)
Передает данные об остатках товаров на витрине.
Обязательно указывайте SKU в точности так, как он указан в каталоге. Например, 557722 и 0557722 — это два разных SKU.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 100 000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /delivery/services
Справочник служб доставки (getDeliveryServices)
Возвращает справочник служб доставки: идентификаторы и наименования.
|⚙️ Лимит: 5 000 запросов в час|
|-|
Return type
Example data
Content-Type: application/json
{
"result" : {
"deliveryService" : [ {
"name" : "name",
"id" : 0
}, {
"name" : "name",
"id" : 0
} ]
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о службах доставки.
GetDeliveryServicesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/hidden-offers
Скрытие товаров и настройки скрытия (addHiddenOffers)
Скрывает товары магазина на Маркете.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Настройки скрытия получены и скоро вступят в силу.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/archive
Добавление товаров в архив (addOffersToArchive)
Помещает товары в архив. Товары, помещенные в архив, скрыты с витрины во всех магазинах кабинета.
{% note warning "В архив нельзя отправить товар, который хранится на складе Маркета" %}
Вначале такой товар нужно распродать или вывезти.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notArchivedOffers" : [ {
"offerId" : "offerId",
"error" : "OFFER_HAS_STOCKS"
}, {
"offerId" : "offerId",
"error" : "OFFER_HAS_STOCKS"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если некоторые товары добавить в архив не удалось, в ответе 200 будет их список.
Список успешно добавленных товаров не возвращается.
AddOffersToArchiveResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /tariffs/calculate
Калькулятор стоимости услуг (calculateTariffs)
Рассчитывает стоимость услуг Маркета для товаров с заданными параметрами. Порядок товаров в запросе и ответе сохраняется, чтобы определить,
для какого товара рассчитана стоимость услуги.
Обратите внимание: калькулятор осуществляет примерные расчеты. Финальная стоимость для каждого заказа зависит от предоставленных услуг.
В запросе можно указать либо параметр campaignId, либо sellingProgram. Совместное использование параметров приведет к ошибке.
|⚙️ Лимит: 100 запросов в минуту|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"offer" : {
"quantity" : 1,
"price" : 0.6027456183070403,
"length" : 0.14658129805029452,
"width" : 0.5962133916683182,
"weight" : 0.23021358869347652,
"categoryId" : 0,
"height" : 0.5637376656633328
},
"tariffs" : [ {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
}, {
"offer" : {
"quantity" : 1,
"price" : 0.6027456183070403,
"length" : 0.14658129805029452,
"width" : 0.5962133916683182,
"weight" : 0.23021358869347652,
"categoryId" : 0,
"height" : 0.5637376656633328
},
"tariffs" : [ {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Стоимость услуг.
CalculateTariffsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/price-quarantine/confirm
Удаление товара из карантина по цене в кабинете (confirmBusinessPrices)
Подтверждает основную цену на товары, которые попали в карантин, и удаляет их из карантина.
Основная цена задается в каталоге и действует во всех магазинах кабинета.
Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин
Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST businesses/{businessId}/price-quarantine.
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ 200 обозначает, что цены подтверждены.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/price-quarantine/confirm
Удаление товара из карантина по цене в магазине (confirmCampaignPrices)
Подтверждает в заданном магазине цену на товары, которые попали в карантин, и удаляет их из карантина.
Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин
Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST campaigns/{campaignId}/price-quarantine.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ 200 обозначает, что цены подтверждены.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/new
Создание нового чата с покупателем (createChat)
Создает новый чат с покупателем.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"chatId" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Все получилось: чат создан.
CreateChatResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers/delete
Удаление товаров из ассортимента магазина (deleteCampaignOffers)
Удаляет заданные товары из заданного магазина.
{% note warning "Запрос удаляет товары именно из конкретного магазина" %}
На продажи в других магазинах и на наличие товара в общем каталоге он не влияет.
{% endnote %}
Товар не получится удалить, если он хранится на складах Маркета.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notDeletedOfferIds" : [ null, null ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине.
DeleteCampaignOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/comments/delete
Удаление комментария к отзыву (deleteGoodsFeedbackComment)
Удаляет комментарий магазина.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/hidden-offers/delete
Возобновление показа товаров (deleteHiddenOffers)
Возобновляет показ скрытых вами товаров магазина на Маркете.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Показ товаров возобновлен.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/delete
Удаление товаров из каталога (deleteOffers)
Удаляет товары из каталога.
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notDeletedOfferIds" : [ null, null ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине.
DeleteOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/unarchive
Удаление товаров из архива (deleteOffersFromArchive)
Восстанавливает товары из архива.
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notUnarchivedOfferIds" : [ null, null ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если некоторые товары восстановить из архива не удалось, в ответе 200 будет их список.
Список успешно восстановленных товаров не возвращается.
DeleteOffersFromArchiveResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos/offers/delete
Удаление товаров из акции (deletePromoOffers)
Убирает товары из акции.
Изменения начинают действовать в течение 4–6 часов.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"rejectedOffers" : [ {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
}, {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Результат удаления товаров из акции.
DeletePromoOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/boost-consolidated/generate
Отчет по бусту продаж (generateBoostConsolidatedReport)
Запускает генерацию сводного отчета по бусту продаж за заданный период. Отчет содержит информацию по всем кампаниям, созданным и через API, и в кабинете.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/competitors-position/generate
Отчет «Конкурентная позиция» (generateCompetitorsPositionReport)
Запускает генерацию отчета «Конкурентная позиция» за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
{% note info "Значение -1 в отчете" %}
Если в CSV-файле в столбце POSITION стоит -1, в этот день не было заказов с товарами в указанной категории.
{% endnote %}
|⚙️ Лимит: 10 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/goods-feedback/generate
Отчет по отзывам о товарах (generateGoodsFeedbackReport)
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/goods-realization/generate
Отчет по реализации (generateGoodsRealizationReport)
Запускает генерацию отчета по реализации за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/documents/labels/generate
Готовые ярлыки‑наклейки на все коробки в нескольких заказах (generateMassOrderLabelsReport)
Запускает генерацию PDF-файла с ярлыками для переданных заказов. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке Маркета для продавцов.
Узнать статус генерации и получить ссылку на готовый файл можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 1000 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый файл.
Если при генерации не удалось найти часть заказов, в ответе на запрос получения готового файла вернется подстатус RESOURCE_NOT_FOUND.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label
Готовый ярлык‑наклейка для коробки в заказе (generateOrderLabel)
Формирует ярлык‑наклейку для коробки в заказе и возвращает ярлык в PDF‑файле.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор грузоместа. default: null format: int64
boxId (required)
Path Parameter — Идентификатор коробки. default: null format: int64
Query parameters
format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. default: null
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/pdfapplication/json
Responses
200
PDF‑файл с ярлыками для коробки. Файл содержит одну страницу с ярлыком.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/labels
Готовые ярлыки‑наклейки на все коробки в одном заказе (generateOrderLabels)
Возвращает PDF-файл с ярлыками, которые нужно наклеить на коробки перед отгрузкой. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке Маркета для продавцов.
На вход нужно передать идентификатор заказа и один необязательный параметр, который управляет версткой PDF-файла.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Query parameters
format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. default: null
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/pdfapplication/json
Responses
200
PDF‑файл с ярлыками на все коробки.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/prices/generate
Отчет «Цены на рынке» (generatePricesReport)
Запускает генерацию отчета «Цены на рынке».
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/shelf-statistics/generate
Отчет по полкам (generateShelfsStatisticsReport)
Запускает генерацию сводного отчета по полкам — рекламным блокам с баннером или видео и набором товаров. Подробнее о них читайте в Справке Маркета для продавцов.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/shows-sales/generate
Отчет «Аналитика продаж» (generateShowsSalesReport)
Запускает генерацию отчета «Аналитика продаж» за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 10 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/stocks-on-warehouses/generate
Отчет по остаткам на складах (generateStocksOnWarehousesReport)
Запускает генерацию отчета по остаткам на складах. Отчет содержит данные:
- Для модели FBY — об остатках на складах Маркета.
- Для остальных моделей — об остатках на соответствующем складе магазина.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/united-marketplace-services/generate
Отчет по стоимости услуг (generateUnitedMarketplaceServicesReport)
Запускает генерацию отчета по стоимости услуг за заданный период. Что это за отчет
Тип отчета зависит от того, какие поля заполнены в запросе:
|Тип отчета |Какие поля нужны |
|-----------------------------|---------------------------------|
|По дате начисления услуги |dateFrom и dateTo |
|По дате формирования акта |year и month |
Заказать отчеты обоих типов одним запросом нельзя.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/united-netting/generate
Отчет по платежам (generateUnitedNettingReport)
Запускает генерацию отчета по платежам за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
Тип отчета зависит от того, какие поля заполнены в запросе:
|Тип отчета |Какие поля нужны |
|-------------------------|---------------------------------------|
|О платежах за период |dateFrom и dateTo |
|О платежном поручении |bankOrderId и bankOrderDateTime |
Заказать отчеты обоих типов одним запросом нельзя.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/united-orders/generate
Отчет по заказам (generateUnitedOrdersReport)
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offers/all
Все предложения магазина (getAllOffers)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет максимально быстро получить информацию обо всех предложениях магазина, размещенных на Маркете. Возвращает результат в виде сегментов нефиксированного размера.
В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Яндекс Маркета, с которой соотнесено предложение, а также аукционные ставки на него.
{% note info %}
Количество предложений считается по данным за последние семь дней (не включая сегодня).
Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
chunk (optional)
Query Parameter —
Номер сегмента с результатами.
Значение по умолчанию: 0.
{% note info %}
Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.
{% endnote %}
{% note alert %}
Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать chunk=0 и т. д.
{% endnote %}
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"offers" : [ {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
}, {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
} ]
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Предложения магазина.
GetAllOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/bids/info
Информация об установленных ставках (getBidsInfoForBusiness)
Возвращает значения ставок для заданных товаров.
{% note warning "" %}
В ответе возвращаются значения только тех ставок, которые вы установили через запрос PUT businesses/{businessId}/bids. Получить информацию по кампаниям, созданным в кабинете, не получится.
{% endnote %}
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"bids" : [ {
"sku" : "sku",
"bid" : 570
}, {
"sku" : "sku",
"bid" : 570
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Значения ставок для заданных товаров. В ответ попадают только товары, на которые установлены ставки.
GetBidsInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/bids/recommendations
Рекомендованные ставки для заданных товаров (getBidsRecommendations)
Возвращает рекомендованные ставки для заданных товаров — такие ставки обеспечивают вашим предложениям определенную долю показов, если цена не превышает рекомендованную.
Для одного товара может возвращаться одна рекомендованная ставка или несколько. Во втором случае разные ставки предназначены для достижения разной доли показов.
Если товар только добавлен в каталог, но пока не продается, рекомендованной ставки для него не будет.
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"recommendations" : [ {
"bidRecommendations" : [ {
"showPercent" : 8,
"bid" : 570
}, {
"showPercent" : 8,
"bid" : 570
} ],
"priceRecommendations" : [ {
"campaignId" : 6,
"price" : 1.1465812980502945
}, {
"campaignId" : 6,
"price" : 1.1465812980502945
} ],
"sku" : "sku",
"bid" : 570
}, {
"bidRecommendations" : [ {
"showPercent" : 8,
"bid" : 570
}, {
"showPercent" : 8,
"bid" : 570
} ],
"priceRecommendations" : [ {
"campaignId" : 6,
"price" : 1.1465812980502945
}, {
"campaignId" : 6,
"price" : 1.1465812980502945
} ],
"sku" : "sku",
"bid" : 570
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Рекомендованные ставки для заданных товаров.
GetBidsRecommendationsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/price-quarantine
Список товаров, находящихся в карантине по цене в кабинете (getBusinessQuarantineOffers)
Возвращает список товаров, которые находятся в карантине по основной цене. Основная цена задается в каталоге и действует во всех магазинах кабинета.
Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST businesses/{businessId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST businesses/{businessId}/offer-prices/updates.
{% note info "𝓠 Что такое карантин?" %}
𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее
{% endnote %}
В запросе можно использовать фильтры.
Результаты возвращаются постранично.
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
}, {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров в карантине.
GetQuarantineOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/settings
Настройки кабинета (getBusinessSettings)
Возвращает информацию о настройках кабинета, идентификатор которого указан в запросе.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Return type
Example data
Content-Type: application/json
{
"result" : {
"settings" : {
"currency" : "RUR",
"onlyDefaultPrice" : true
},
"info" : {
"name" : "name",
"id" : 0
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Настройки кабинета.
GetBusinessSettingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}
Информация о магазине (getCampaign)
Возвращает информацию о магазине.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"campaign" : {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о магазине.
GetCampaignResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/logins
Логины, связанные с магазином (getCampaignLogins)
Возвращает список логинов, у которых есть доступ к магазину.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"logins" : [ "logins", "logins" ]
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список логинов, связанных с магазином.
GetCampaignLoginsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers
Информация о товарах, которые размещены в заданном магазине (getCampaignOffers)
Возвращает список товаров, которые размещены в заданном магазине. Для каждого товара указываются параметры размещения.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"campaignPrice" : {
"vat" : 5,
"discountBase" : 5.962133916683182,
"currencyId" : "RUR",
"value" : 1.4658129805029452,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"available" : true,
"offerId" : "offerId",
"quantum" : {
"minQuantity" : 1,
"stepQuantity" : 60
},
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"status" : "PUBLISHED"
}, {
"campaignPrice" : {
"vat" : 5,
"discountBase" : 5.962133916683182,
"currencyId" : "RUR",
"value" : 1.4658129805029452,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"available" : true,
"offerId" : "offerId",
"quantum" : {
"minQuantity" : 1,
"stepQuantity" : 60
},
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"status" : "PUBLISHED"
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров, размещенных в заданном магазине.
GetCampaignOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/price-quarantine
Список товаров, находящихся в карантине по цене в магазине (getCampaignQuarantineOffers)
Возвращает список товаров, которые находятся в карантине по цене, установленной в заданном магазине.
Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST campaigns/{campaignId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST campaigns/{campaignId}/offer-prices/updates.
{% note info "𝓠 Что такое карантин?" %}
𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее
{% endnote %}
В запросе можно использовать фильтры.
Результаты возвращаются постранично.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
}, {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров в карантине.
GetQuarantineOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/region
Регион магазина (getCampaignRegion)
{% note warning "" %}
Этот метод устарел. Вместо него используйте GET campaigns/{campaignId}/settings.
{% endnote %}
Возвращает регион, в котором находится магазин.
|⚙️ Лимит: 5 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Возвращает регион, в котором находится магазин.
|⚙️ Лимит: 1000 запросов в час|
|-|
GetCampaignRegionResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/settings
Настройки магазина (getCampaignSettings)
Возвращает информацию о настройках магазина, идентификатор которого указан в запросе.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"settings" : {
"showInPremium" : true,
"showInContext" : true,
"localRegion" : {
"delivery" : {
"schedule" : {
"customWorkingDays" : [ "23-09-2022", "23-09-2022" ],
"period" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022"
},
"customHolidays" : [ "23-09-2022", "23-09-2022" ],
"weeklyHolidays" : [ 1, 1 ],
"availableOnHolidays" : true,
"totalHolidays" : [ "23-09-2022", "23-09-2022" ]
}
},
"name" : "name",
"id" : 6,
"type" : "OTHER",
"deliveryOptionsSource" : "WEB"
},
"countryRegion" : 0,
"shopName" : "shopName",
"useOpenStat" : true
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Настройки магазина.
GetCampaignSettingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Список магазинов пользователя (getCampaigns)
Возвращает список магазинов, к которым имеет доступ пользователь — владелец авторизационного токена, использованного в запросе. Для агентских пользователей список состоит из подагентских магазинов.
|⚙️ Лимит: 1000 запросов в час|
|-|
Query parameters
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"campaigns" : [ {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
}, {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
} ],
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Магазины пользователя.
GetCampaignsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/by_login/{login}
Магазины, доступные логину (getCampaignsByLogin)
Возвращает список магазинов, к которым у пользователя с указанным логином есть доступ.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
login (required)
Path Parameter — Логин пользователя. default: null
Query parameters
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"campaigns" : [ {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
}, {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
} ],
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о магазинах.
GetCampaignsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /categories/max-sale-quantum
Лимит на установку кванта продажи и минимального количества товаров в заказе (getCategoriesMaxSaleQuantum)
Возвращает лимит на установку кванта и минимального количества товаров в заказе, которые вы можете задать для товаров указанных категорий.
Если вы передадите значение кванта или минимального количества товаров выше установленного Маркетом ограничения, товар будет скрыт с витрины.
Подробнее о том, как продавать товары по несколько штук, читайте в Справке Маркета для продавцов.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"results" : [ {
"maxSaleQuantum" : 6,
"name" : "name",
"id" : 0
}, {
"maxSaleQuantum" : 6,
"name" : "name",
"id" : 0
} ],
"errors" : [ {
"type" : "UNKNOWN_CATEGORY",
"categoryId" : 1
}, {
"type" : "UNKNOWN_CATEGORY",
"categoryId" : 1
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Лимит на установку кванта и минимального количества товаров.
GetCategoriesMaxSaleQuantumResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Дерево категорий (getCategoriesTree)
Возвращает дерево категорий Маркета.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Категории Маркета.
GetCategoriesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /category/{categoryId}/parameters
Списки характеристик товаров по категориям (getCategoryContentParameters)
Возвращает список характеристик с допустимыми значениями для заданной категории.
|⚙️ Лимит: 50 категорий в минуту |
|-|
Path parameters
categoryId (required)
Path Parameter —
Идентификатор категории на Маркете.
Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом POST categories/tree.
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"parameters" : [ {
"values" : [ {
"description" : "description",
"id" : 5,
"value" : "value"
}, {
"description" : "description",
"id" : 5,
"value" : "value"
} ],
"recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
"description" : "description",
"type" : "TEXT",
"constraints" : {
"minValue" : 2.3021358869347655,
"maxValue" : 7.061401241503109,
"maxLength" : 9
},
"required" : true,
"multivalue" : true,
"unit" : {
"defaultUnitId" : 1,
"units" : [ {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
}, {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
} ]
},
"valueRestrictions" : [ {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
}, {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
} ],
"distinctive" : true,
"name" : "name",
"id" : 6,
"filtering" : true,
"allowCustomValues" : true
}, {
"values" : [ {
"description" : "description",
"id" : 5,
"value" : "value"
}, {
"description" : "description",
"id" : 5,
"value" : "value"
} ],
"recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
"description" : "description",
"type" : "TEXT",
"constraints" : {
"minValue" : 2.3021358869347655,
"maxValue" : 7.061401241503109,
"maxLength" : 9
},
"required" : true,
"multivalue" : true,
"unit" : {
"defaultUnitId" : 1,
"units" : [ {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
}, {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
} ]
},
"valueRestrictions" : [ {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
}, {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
} ],
"distinctive" : true,
"name" : "name",
"id" : 6,
"filtering" : true,
"allowCustomValues" : true
} ],
"categoryId" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список характеристик товаров из заданной категории.
GetCategoryContentParametersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/history
Получение истории сообщений в чате (getChatHistory)
Возвращает историю сообщений в чате с покупателем.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"orderId" : 0,
"messages" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"sender" : "PARTNER",
"payload" : [ {
"size" : 1,
"name" : "name",
"url" : "url"
}, {
"size" : 1,
"name" : "name",
"url" : "url"
} ],
"messageId" : 6,
"message" : "message"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"sender" : "PARTNER",
"payload" : [ {
"size" : 1,
"name" : "name",
"url" : "url"
}, {
"size" : 1,
"name" : "name",
"url" : "url"
} ],
"messageId" : 6,
"message" : "message"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
История сообщений успешно получена.
GetChatHistoryResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats
Получение доступных чатов (getChats)
Возвращает ваши чаты с покупателями.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"chats" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"chatId" : 0,
"orderId" : 6,
"type" : "CHAT",
"status" : "NEW",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"chatId" : 0,
"orderId" : 6,
"type" : "CHAT",
"status" : "NEW",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список чатов.
GetChatsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /delivery/services
Справочник служб доставки (getDeliveryServices)
Возвращает справочник служб доставки: идентификаторы и наименования.
|⚙️ Лимит: 5 000 запросов в час|
|-|
Return type
Example data
Content-Type: application/json
{
"result" : {
"deliveryService" : [ {
"name" : "name",
"id" : 0
}, {
"name" : "name",
"id" : 0
} ]
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о службах доставки.
GetDeliveryServicesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feeds/{feedId}
Информация о прайс-листе (getFeed)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает информацию о прайс-листе, размещенном на Маркете для заданного магазина. Также ресурс возвращает результаты автоматических проверок прайс-листа.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"feed" : {
"password" : "password",
"download" : {
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 5
}
},
"uploadDate" : "2000-01-23T04:56:07.000+00:00",
"publication" : {
"priceAndStockUpdate" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
},
"full" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
}
},
"name" : "name",
"id" : 0,
"placement" : {
"totalOffersCount" : 5
},
"login" : "login",
"url" : "url",
"content" : {
"rejectedOffersCount" : 6,
"error" : {
"type" : "PARSE_ERROR"
},
"status" : "ERROR",
"totalOffersCount" : 1
}
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о прайс-листе.
GetFeedResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feeds/{feedId}/index-logs
Отчет по индексации прайс-листа (getFeedIndexLogs)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает отчет по индексации прайс-листа для заданного магазина. Отчет позволяет получить статистику загрузки прайс-листа и результаты его автоматических проверок.
Данные в отчете возвращаются в порядке убывания значений параметра generationId.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Query parameters
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
published_time_from (optional)
Query Parameter —
Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
Значение по умолчанию: последние восемь дней со времени отправки запроса.
default: null format: date-time
published_time_to (optional)
Query Parameter —
Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-31T00:42:42+03:00.
Значение по умолчанию: дата и время отправки запроса.
{% note info %}
Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра published_time_to. Значение параметра не должно быть датой из будущего.
{% endnote %}
default: null format: date-time
status (optional)
Query Parameter —
Статус индексации и проверки прайс-листа на соответствие техническим требованиям.
Возможные значения:
ERROR — произошли ошибки.OK — обработан без ошибок.WARNING — наблюдались некритичные проблемы.
default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"feed" : {
"id" : 0
},
"total" : 2,
"indexLogRecords" : [ {
"offers" : {
"rejectedCount" : 5,
"totalCount" : 5
},
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"generationId" : 6,
"indexType" : "DIFF",
"publishedTime" : "2000-01-23T04:56:07.000+00:00",
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 1
},
"downloadTime" : "2000-01-23T04:56:07.000+00:00",
"status" : "ERROR"
}, {
"offers" : {
"rejectedCount" : 5,
"totalCount" : 5
},
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"generationId" : 6,
"indexType" : "DIFF",
"publishedTime" : "2000-01-23T04:56:07.000+00:00",
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 1
},
"downloadTime" : "2000-01-23T04:56:07.000+00:00",
"status" : "ERROR"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Отчет по индексации прайс-листа.
GetFeedIndexLogsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feedback/updates
Новые и обновленные отзывы о магазине (getFeedbackAndCommentUpdates)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает новые и обновленные отзывы о магазине на Маркете.
Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Выходные данные содержат идентификатор следующей страницы.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
from_date (optional)
Query Parameter —
Начальная дата обновления отзывов.
Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.
Формат даты: ГГГГ-ММ-ДД.
default: null format: date
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
},
"feedbackList" : [ {
"comments" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"shop" : {
"name" : "name"
},
"author" : {
"name" : "name",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}
},
"verified" : true,
"recommend" : true,
"grades" : {
"average" : 5.962133916683182,
"agreeCount" : 5,
"rejectCount" : 2,
"factors" : [ {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
}, {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
} ]
},
"pro" : "pro",
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"text" : "text",
"state" : "LAST",
"contra" : "contra",
"resolved" : true,
"order" : {
"delivery" : "DELIVERY",
"shopOrderId" : "shopOrderId"
}
}, {
"comments" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"shop" : {
"name" : "name"
},
"author" : {
"name" : "name",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}
},
"verified" : true,
"recommend" : true,
"grades" : {
"average" : 5.962133916683182,
"agreeCount" : 5,
"rejectCount" : 2,
"factors" : [ {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
}, {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
} ]
},
"pro" : "pro",
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"text" : "text",
"state" : "LAST",
"contra" : "contra",
"resolved" : true,
"order" : {
"delivery" : "DELIVERY",
"shopOrderId" : "shopOrderId"
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список отзывов для магазина.
GetFeedbackListResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feeds
Список прайс-листов магазина (getFeeds)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает список прайс-листов, размещенных на Маркете для магазина. Также ресурс возвращает результаты автоматических проверок прайс-листов.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"feeds" : [ {
"password" : "password",
"download" : {
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 5
}
},
"uploadDate" : "2000-01-23T04:56:07.000+00:00",
"publication" : {
"priceAndStockUpdate" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
},
"full" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
}
},
"name" : "name",
"id" : 0,
"placement" : {
"totalOffersCount" : 5
},
"login" : "login",
"url" : "url",
"content" : {
"rejectedOffersCount" : 6,
"error" : {
"type" : "PARSE_ERROR"
},
"status" : "ERROR",
"totalOffersCount" : 1
}
}, {
"password" : "password",
"download" : {
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 5
}
},
"uploadDate" : "2000-01-23T04:56:07.000+00:00",
"publication" : {
"priceAndStockUpdate" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
},
"full" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
}
},
"name" : "name",
"id" : 0,
"placement" : {
"totalOffersCount" : 5
},
"login" : "login",
"url" : "url",
"content" : {
"rejectedOffersCount" : 6,
"error" : {
"type" : "PARSE_ERROR"
},
"status" : "ERROR",
"totalOffersCount" : 1
}
} ]
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список прайс-листов.
GetFeedsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/comments
Получение комментариев к отзыву (getGoodsFeedbackComments)
Возвращает комментарии к отзыву.
Результаты возвращаются постранично, одна страница содержит не более 20 комментариев.
Комментарии расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"comments" : [ {
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 0,
"text" : "text",
"canModify" : true,
"parentId" : 6,
"status" : "PUBLISHED"
}, {
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 0,
"text" : "text",
"canModify" : true,
"parentId" : 6,
"status" : "PUBLISHED"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Дерево комментариев к отзыву.
GetGoodsFeedbackCommentsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback
Получение отзывов о товарах продавца (getGoodsFeedbacks)
Возвращает все отзывы о товарах продавца по указанным фильтрам.
Результаты возвращаются постранично, одна страница содержит не более 20 отзывов.
Отзывы расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"feedbacks" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"needReaction" : true,
"identifiers" : {
"orderId" : 6,
"modelId" : 1
},
"author" : "author",
"feedbackId" : 0,
"description" : {
"advantages" : "advantages",
"disadvantages" : "disadvantages",
"comment" : "comment"
},
"media" : {
"videos" : [ "videos", "videos" ],
"photos" : [ "photos", "photos" ]
},
"statistics" : {
"commentsCount" : 5,
"rating" : 3,
"paidAmount" : 2,
"recommended" : true
}
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"needReaction" : true,
"identifiers" : {
"orderId" : 6,
"modelId" : 1
},
"author" : "author",
"feedbackId" : 0,
"description" : {
"advantages" : "advantages",
"disadvantages" : "disadvantages",
"comment" : "comment"
},
"media" : {
"videos" : [ "videos", "videos" ],
"photos" : [ "photos", "photos" ]
},
"statistics" : {
"commentsCount" : 5,
"rating" : 3,
"paidAmount" : 2,
"recommended" : true
}
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список отзывов.
GetGoodsFeedbackResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/stats/skus
Отчет по товарам (getGoodsStats)
Возвращает подробный отчет по товарам, которые вы разместили на Маркете. С помощью отчета вы можете узнать, например, об остатках на складе, об условиях хранения ваших товаров и т. д.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"shopSkus" : [ {
"shopSku" : "shopSku",
"marketSku" : 0,
"price" : 6.027456183070403,
"name" : "name",
"warehouses" : [ {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
}, {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
} ],
"weightDimensions" : {
"length" : 5.962133916683182,
"width" : 5.637376656633329,
"weight" : 7.061401241503109,
"height" : 2.3021358869347655
},
"categoryName" : "categoryName",
"categoryId" : 1,
"pictures" : [ "pictures", "pictures" ],
"tariffs" : [ {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
}, {
"shopSku" : "shopSku",
"marketSku" : 0,
"price" : 6.027456183070403,
"name" : "name",
"warehouses" : [ {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
}, {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
} ],
"weightDimensions" : {
"length" : 5.962133916683182,
"width" : 5.637376656633329,
"weight" : 7.061401241503109,
"height" : 2.3021358869347655
},
"categoryName" : "categoryName",
"categoryId" : 1,
"pictures" : [ "pictures", "pictures" ],
"tariffs" : [ {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Отчет по товарам.
GetGoodsStatsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/hidden-offers
Информация о скрытых вами товарах (getHiddenOffers)
Возвращает список скрытых вами товаров для заданного магазина.
В списке будут товары, скрытые любым способом — по API, с помощью YML-фида, в кабинете и так далее.
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
offer_id (optional)
Query Parameter — Идентификатор скрытого предложения. default: null
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
offset (optional)
Query Parameter —
Позиция в списке, начиная с которой возвращаются результаты ответа.
Используется вместе с параметром limit.
Если задан offset, параметры page_number и page_size игнорируются.
offset игнорируется, если задан page_token.
default: null format: int32
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"hiddenOffers" : [ {
"offerId" : "offerId"
}, {
"offerId" : "offerId"
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о скрытых вами товарах.
GetHiddenOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-cards
Получение информации о заполненности карточек магазина (getOfferCardsContentStatus)
Возвращает сведения о состоянии контента для заданных товаров:
- создана ли карточка товара и в каком она статусе;
- заполненность карточки в процентах;
- переданные характеристики товаров;
- есть ли ошибки или предупреждения, связанные с контентом;
- рекомендации по заполнению карточки.
|⚙️ Лимит: 600 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offerCards" : [ {
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"offerId" : "offerId",
"contentRating" : 0,
"recommendations" : [ {
"type" : "HAS_VIDEO",
"percent" : 60
}, {
"type" : "HAS_VIDEO",
"percent" : 60
} ],
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"parameterValues" : [ {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
}, {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
} ]
}, {
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"offerId" : "offerId",
"contentRating" : 0,
"recommendations" : [ {
"type" : "HAS_VIDEO",
"percent" : 60
}, {
"type" : "HAS_VIDEO",
"percent" : 60
} ],
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"parameterValues" : [ {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
}, {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
} ]
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о карточках указанных товаров.
GetOfferCardsContentStatusResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offer-mapping-entries
Список товаров в каталоге (getOfferMappingEntries)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings.
{% endnote %}
Для каждого товара, который вы размещаете на Маркете, возвращается информация о карточках Маркета, к которым привязан этот товар:
- Идентификатор текущей карточки (marketSku), карточки, которая проходит модерацию и последней отклоненной карточки.
- Описание товара, которое указано на карточке Маркета. Например, размер упаковки и вес товара.
Результаты возвращаются постранично. Выходные данные содержат идентификатор следующей страницы.
{% note info %}
Количество товаров в каталоге магазина считается по данным за последние семь дней (не включая сегодня).
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
offer_id (optional)
Query Parameter — Идентификатор товара в каталоге. default: null
shop_sku (optional)
Query Parameter —
Ваш SKU товара.
Параметр может быть указан несколько раз, например:
...shop_sku=123&shop_sku=129&shop_sku=141...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
mapping_kind (optional)
Query Parameter — Тип маппинга. default: null
status (optional)
Query Parameter —
Фильтрация по статусу публикации товара:
READY — товар прошел модерацию.IN_WORK — товар проходит модерацию.NEED_CONTENT — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.NEED_INFO — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.REJECTED — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.SUSPENDED — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.OTHER — товар не прошел модерацию по другой причине.
Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
availability (optional)
Query Parameter —
Фильтрация по планам поставок товара:
ACTIVE — поставки будут.INACTIVE — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.DELISTED — архив: товар закончился на складе, и его поставок больше не будет.
Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
category_id (optional)
Query Parameter —
Фильтрация по идентификатору категории на Маркете.
Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом POST categories/tree.
Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
vendor (optional)
Query Parameter —
Фильтрация по бренду товара.
Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.
Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе Кодирование URL русскоязычной Википедии.
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offerMappingEntries" : [ {
"offer" : {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
},
"mapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"awaitingModerationMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"rejectedMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
}
}, {
"offer" : {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
},
"mapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"awaitingModerationMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"rejectedMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
}
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о товарах в каталоге.
GetOfferMappingEntriesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings
Информация о товарах в каталоге (getOfferMappings)
Возвращает список товаров в каталоге, их категории на Маркете и характеристики каждого товара.
Можно использовать тремя способами:
- задать список интересующих SKU;
- задать фильтр — в этом случае результаты возвращаются постранично;
- не передавать тело запроса, чтобы получить список всех товаров в каталоге.
|⚙️ Лимит: 600 запросов в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
},
"offerMappings" : [ {
"offer" : {
"downloadable" : true,
"sellingPrograms" : [ {
"sellingProgram" : "FBY",
"status" : "FINE"
}, {
"sellingProgram" : "FBY",
"status" : "FINE"
} ],
"marketCategoryId" : 0,
"manufacturerCountries" : [ "Россия", "Россия" ],
"description" : "description",
"videos" : [ "videos", "videos", "videos", "videos", "videos" ],
"purchasePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"type" : "DEFAULT",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"archived" : true,
"campaigns" : [ {
"campaignId" : 9,
"status" : "PUBLISHED"
}, {
"campaignId" : 9,
"status" : "PUBLISHED"
} ],
"vendor" : "LEVENHUK",
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"barcodes" : [ "46012300000000", "46012300000000" ],
"params" : [ {
"name" : "Wi-Fi",
"value" : "есть"
}, {
"name" : "Wi-Fi",
"value" : "есть"
} ],
"tags" : [ "до 500 рублей", "до 500 рублей" ],
"condition" : {
"reason" : "reason",
"type" : "PREOWNED",
"quality" : "PERFECT"
},
"certificates" : [ "certificates", "certificates" ],
"boxCount" : 1,
"additionalExpenses" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"customsCommodityCode" : "8517610008",
"adult" : true,
"age" : {
"ageUnit" : "YEAR",
"value" : 0.5962133916683182
},
"manuals" : [ {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
} ]
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
}, {
"offer" : {
"downloadable" : true,
"sellingPrograms" : [ {
"sellingProgram" : "FBY",
"status" : "FINE"
}, {
"sellingProgram" : "FBY",
"status" : "FINE"
} ],
"marketCategoryId" : 0,
"manufacturerCountries" : [ "Россия", "Россия" ],
"description" : "description",
"videos" : [ "videos", "videos", "videos", "videos", "videos" ],
"purchasePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"type" : "DEFAULT",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"archived" : true,
"campaigns" : [ {
"campaignId" : 9,
"status" : "PUBLISHED"
}, {
"campaignId" : 9,
"status" : "PUBLISHED"
} ],
"vendor" : "LEVENHUK",
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"barcodes" : [ "46012300000000", "46012300000000" ],
"params" : [ {
"name" : "Wi-Fi",
"value" : "есть"
}, {
"name" : "Wi-Fi",
"value" : "есть"
} ],
"tags" : [ "до 500 рублей", "до 500 рублей" ],
"condition" : {
"reason" : "reason",
"type" : "PREOWNED",
"quality" : "PERFECT"
},
"certificates" : [ "certificates", "certificates" ],
"boxCount" : 1,
"additionalExpenses" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"customsCommodityCode" : "8517610008",
"adult" : true,
"age" : {
"ageUnit" : "YEAR",
"value" : 0.5962133916683182
},
"manuals" : [ {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
} ]
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о товарах в каталоге.
GetOfferMappingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offers/recommendations
Рекомендации Маркета, касающиеся цен (getOfferRecommendations)
Метод возвращает рекомендации нескольких типов.
1. Порог для привлекательной цены. Он нужен для участия в софинансировании скидок.
Показывает, какие цены для участия нужно установить, чтобы получить максимальные шансы на срабатывание скидок, софинансируемых Маркетом. Как это устроено
2. Оценка привлекательности цен на витрине.
Привлекательность влияет на вероятность срабатывания скидок за счет Маркета. Как это устроено
В запросе можно использовать фильтры.
Результаты возвращаются постранично.
|⚙️ Лимит: 100 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
},
"offerRecommendations" : [ {
"offer" : {
"shows" : 0,
"price" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitiveness" : "OPTIMAL",
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}
},
"recommendation" : {
"recommendedCofinancePrice" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitivenessThresholds" : {
"optimalPrice" : {
"value" : 0.9301444243932576
},
"averagePrice" : {
"value" : 0.9301444243932576
}
}
}
}, {
"offer" : {
"shows" : 0,
"price" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitiveness" : "OPTIMAL",
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}
},
"recommendation" : {
"recommendedCofinancePrice" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitivenessThresholds" : {
"optimalPrice" : {
"value" : 0.9301444243932576
},
"averagePrice" : {
"value" : 0.9301444243932576
}
}
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров с рекомендациями.
GetOfferRecommendationsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offers
Предложения магазина (getOffers)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет фильтровать информацию о предложениях магазина, размещенных на Маркете, и искать предложения по заданному поисковому запросу.
Поиск предложений, размещенных на Маркете, работает по поисковому запросу аналогично поиску Маркета. Результаты возвращаются с использованием пейджера.
В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Маркета, с которой соотнесено предложение, и аукционные ставки на него.
{% note info %}
Из-за особенностей поиска Маркета иногда на последних страницах пейджера фактическое количество результатов оказывается меньше количества, указанного ранее на предыдущих страницах.
В связи с этим настоятельно рекомендуется анализировать содержимое параметра pager для каждой полученной страницы.
{% endnote %}
{% note info %}
Количество предложений считается по данным за последние семь дней (не включая сегодня).
Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
query (optional)
Query Parameter —
Поисковый запрос.
Поддерживается язык запросов.
Значение по умолчанию: все предложения магазина, размещенные на Маркете.
default: null
feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
shopCategoryId (optional)
Query Parameter —
Идентификатор категории предложения, указанный магазином в прайс-листе.
Параметр выводится только для предложений, у которых указана категория в прайс-листе.
Параметр доступен начиная с версии 2.0 партнерского API.
default: null
currency (optional)
Query Parameter —
Валюта, в которой указана цена предложения.
Возможные значения:
default: null
matched (optional)
Query Parameter —
Фильтр по признаку соотнесения предложения и карточки модели.
Возможные значения:
-
0 / FALSE / NO — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.
-
1 / TRUE / YES — поиск выполняется среди предложений, соотнесенных с карточками моделей).
default: null
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"offers" : [ {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
}, {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
} ],
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Предложения магазина.
GetOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}
Информация об одном заказе (getOrder)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"order" : {
"delivery" : {
"dispatchType" : "UNKNOWN",
"address" : {
"country" : "country",
"city" : "city",
"postcode" : "postcode",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"house" : "house",
"subway" : "subway",
"phone" : "phone",
"street" : "street",
"district" : "district",
"recipient" : "recipient",
"entryphone" : "entryphone",
"block" : "block",
"entrance" : "entrance",
"floor" : "floor",
"apartment" : "apartment"
},
"liftType" : "NOT_NEEDED",
"deliveryServiceId" : 6,
"estimated" : true,
"dates" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022",
"fromTime" : "fromTime",
"toTime" : "toTime",
"realDeliveryDate" : "23-09-2022"
},
"type" : "DELIVERY",
"serviceName" : "serviceName",
"shipments" : [ {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
}, {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
} ],
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ],
"courier" : {
"vehicleDescription" : "vehicleDescription",
"phone" : "phone",
"phoneExtension" : "phoneExtension",
"fullName" : "fullName",
"vehicleNumber" : "vehicleNumber"
},
"price" : 5.025004791520295,
"outletStorageLimitDate" : "23-09-2022",
"eacType" : "MERCHANT_TO_COURIER",
"liftPrice" : 8.762042012749001,
"eacCode" : "eacCode",
"id" : "id",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"deliveryPartnerType" : "SHOP",
"outletCode" : "outletCode"
},
"notes" : "notes",
"substatus" : "RESERVATION_EXPIRED",
"deliveryTotal" : 1.4658129805029452,
"buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
"creationDate" : "23-09-2022 09:12:41",
"buyerItemsTotal" : 5.962133916683182,
"paymentType" : "PREPAID",
"buyer" : {
"lastName" : "lastName",
"firstName" : "firstName",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"expiryDate" : "23-09-2022 09:12:41",
"buyerTotalBeforeDiscount" : 7.061401241503109,
"itemsTotal" : 6.027456183070403,
"buyerTotal" : 5.637376656633329,
"subsidies" : [ {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
} ],
"paymentMethod" : "CASH_ON_DELIVERY",
"currency" : "RUR",
"fake" : true,
"id" : 0,
"taxSystem" : "OSN",
"cancelRequested" : true,
"items" : [ {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
}, {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
} ],
"status" : "PLACING",
"updatedAt" : "23-09-2022 09:12:41"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о заказе.
GetOrderResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/{orderId}/business-buyer
Информация о покупателе — юридическом лице (getOrderBusinessBuyerInfo)
Возвращает информацию о покупателе по идентификатору заказа.
{% note info "" %}
Чтобы получить информацию о покупателе, который является физическим лицом, воспользуйтесь запросом GET campaigns/{campaignId}/orders/{orderId}/buyer.
{% endnote %}
Получить данные можно, только если заказ находится в статусе PROCESSING, DELIVERY, PICKUP или DELIVERED.
Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.
|⚙️ Лимит: 3 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"organizationName" : "organizationName",
"organizationJurAddress" : "organizationJurAddress",
"inn" : "inn",
"kpp" : "kpp"
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о покупателе.
GetBusinessBuyerInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/{orderId}/documents
Информация о документах (getOrderBusinessDocumentsInfo)
Возвращает информацию о документах по идентификатору заказа.
Получить данные можно после того, как заказ перейдет в статус DELIVERED.
Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.
|⚙️ Лимит: 3 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"sf" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"torgTwelve" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"upd" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"ukd" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"ksf" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о документах.
GetBusinessDocumentsInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/labels/data
Данные для самостоятельного изготовления ярлыков (getOrderLabelsData)
Возвращает информацию на ярлыках, которые клеятся на коробки в заказе.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"parcelBoxLabels" : [ {
"supplierName" : "supplierName",
"deliveryServiceId" : "deliveryServiceId",
"orderId" : 1,
"fulfilmentId" : "fulfilmentId",
"orderNum" : "orderNum",
"weight" : "weight",
"url" : "url",
"deliveryServiceName" : "deliveryServiceName",
"deliveryAddress" : "deliveryAddress",
"recipientName" : "recipientName",
"place" : "place",
"shipmentDate" : "shipmentDate",
"boxId" : 5
}, {
"supplierName" : "supplierName",
"deliveryServiceId" : "deliveryServiceId",
"orderId" : 1,
"fulfilmentId" : "fulfilmentId",
"orderNum" : "orderNum",
"weight" : "weight",
"url" : "url",
"deliveryServiceName" : "deliveryServiceName",
"deliveryAddress" : "deliveryAddress",
"recipientName" : "recipientName",
"place" : "place",
"shipmentDate" : "shipmentDate",
"boxId" : 5
} ],
"orderId" : 0,
"placesNumber" : 6,
"url" : "url"
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация для печати ярлыков.
GetOrderLabelsDataResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders
Информация о нескольких заказах (getOrders)
Возвращает информацию о заказах. Запрос можно использовать, чтобы узнать, нет ли новых заказов.
Доступна фильтрация по нескольким характеристикам заказов:
-
дате оформления;
-
статусу;
-
идентификаторам заказов;
-
этапу обработки или причине отмены;
-
типу (настоящий или тестовый);
-
дате отгрузки в службу доставки;
-
дате и времени обновления заказа.
Информация о заказах, доставленных или отмененных больше 30 дней назад, не возвращается. Ее можно получить с помощью запроса информации об отдельном заказе GET campaigns/{campaignId}/orders/{orderId} (если у вас есть идентификатор заказа) или запроса отчета по заказам POST campaigns/{campaignId}/stats/orders.
Максимальный диапазон дат за один запрос к ресурсу — 30 дней. Максимальное количество заказов в выходных данных запроса — 50.
Результаты возвращаются постранично. Для навигации по страницам используйте параметры page_token и limit.
Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса GET campaigns/{campaignId}/orders/{orderId}/buyer.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
orderIds (optional)
Query Parameter — Фильтрация заказов по идентификаторам.
⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. default: null format: int64
status (optional)
Query Parameter —
Статус заказа:
-
CANCELLED — заказ отменен.
-
DELIVERED — заказ получен покупателем.
-
DELIVERY — заказ передан в службу доставки.
-
PICKUP — заказ доставлен в пункт самовывоза.
-
PROCESSING — заказ находится в обработке.
-
UNPAID — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении).
Также могут возвращаться другие значения. Обрабатывать их не требуется.
default: null
substatus (optional)
Query Parameter —
Этап обработки заказа (если он имеет статус PROCESSING) или причина отмены заказа (если он имеет статус CANCELLED).
Возможные значения для заказа в статусе PROCESSING:
STARTED — заказ подтвержден, его можно начать обрабатывать.READY_TO_SHIP — заказ собран и готов к отправке.SHIPPED — заказ передан службе доставки.
Возможные значения для заказа в статусе CANCELLED:
-
DELIVERY_SERVICE_UNDELIVERED — служба доставки не смогла доставить заказ.
-
PROCESSING_EXPIRED — значение более не используется.
-
REPLACING_ORDER — покупатель решил заменить товар другим по собственной инициативе.
-
RESERVATION_EXPIRED — покупатель не завершил оформление зарезервированного заказа в течение 10 минут.
-
RESERVATION_FAILED — Маркет не может продолжить дальнейшую обработку заказа.
-
SHOP_FAILED — магазин не может выполнить заказ.
-
USER_CHANGED_MIND — покупатель отменил заказ по личным причинам.
-
USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут.
-
USER_REFUSED_DELIVERY — покупателя не устроили условия доставки.
-
USER_REFUSED_PRODUCT — покупателю не подошел товар.
-
USER_REFUSED_QUALITY — покупателя не устроило качество товара.
-
USER_UNREACHABLE — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:
- не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
- перерыв между первым и третьим звонком не менее 90 минут;
- соединение не короче 5 секунд.
Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.
-
USER_WANTS_TO_CHANGE_DELIVERY_DATE — покупатель хочет получить заказ в другой день.
-
CANCELLED_COURIER_NOT_FOUND — не удалось найти курьера.
Также могут возвращаться другие значения. Обрабатывать их не требуется.
default: null
fromDate (optional)
Query Parameter —
Начальная дата для фильтрации заказов по дате оформления.
Формат даты: ДД-ММ-ГГГГ.
Между начальной и конечной датой (параметр toDate) должно быть не больше 30 дней.
Значение по умолчанию: 30 дней назад от текущей даты.
default: null format: date
toDate (optional)
Query Parameter —
Конечная дата для фильтрации заказов по дате оформления.
Показываются заказы, созданные до 00:00 указанного дня.
Формат даты: ДД-ММ-ГГГГ.
Между начальной (параметр fromDate) и конечной датой должно быть не больше 30 дней.
Значение по умолчанию: текущая дата.
default: null format: date
supplierShipmentDateFrom (optional)
Query Parameter —
Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).
Формат даты: ДД-ММ-ГГГГ.
Между начальной и конечной датой (параметр supplierShipmentDateTo) должно быть не больше 30 дней.
Начальная дата включается в интервал для фильтрации.
default: null format: date
supplierShipmentDateTo (optional)
Query Parameter —
Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).
Формат даты: ДД-ММ-ГГГГ.
Между начальной (параметр supplierShipmentDateFrom) и конечной датой должно быть не больше 30 дней.
Конечная дата не включается в интервал для фильтрации.
default: null format: date
updatedAtFrom (optional)
Query Parameter —
Начальная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
Между начальной и конечной датой (параметр updatedAtTo) должно быть не больше 30 дней.
Начальная дата включается в интервал для фильтрации.
default: null format: date-time
updatedAtTo (optional)
Query Parameter —
Конечная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
Между начальной (параметр updatedAtFrom) и конечной датой должно быть не больше 30 дней.
Конечная дата не включается в интервал для фильтрации.
default: null format: date-time
dispatchType (optional)
Query Parameter — Способ отгрузки default: null
fake (optional)
Query Parameter —
Фильтрация заказов по типам:
default: false
hasCis (optional)
Query Parameter —
Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации в системе «Честный ЗНАК»:
Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.
default: false
onlyWaitingForCancellationApprove (optional)
Query Parameter —
Только для модели DBS
Фильтрация заказов по наличию запросов покупателей на отмену.
При значение true возвращаются только заказы, которые находятся в статусе DELIVERY или PICKUP и которые пользователи решили отменить.
Чтобы подтвердить или отклонить отмену, отправьте запрос PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept.
default: false
onlyEstimatedDelivery (optional)
Query Parameter —
Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки:
true — возвращаются только заказы с неподтвержденной датой доставки.false — фильтрация не применяется.
default: false
buyerType (optional)
Query Parameter — Фильтрация заказов по типу покупателя. default: null
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
},
"orders" : [ {
"delivery" : {
"dispatchType" : "UNKNOWN",
"address" : {
"country" : "country",
"city" : "city",
"postcode" : "postcode",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"house" : "house",
"subway" : "subway",
"phone" : "phone",
"street" : "street",
"district" : "district",
"recipient" : "recipient",
"entryphone" : "entryphone",
"block" : "block",
"entrance" : "entrance",
"floor" : "floor",
"apartment" : "apartment"
},
"liftType" : "NOT_NEEDED",
"deliveryServiceId" : 6,
"estimated" : true,
"dates" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022",
"fromTime" : "fromTime",
"toTime" : "toTime",
"realDeliveryDate" : "23-09-2022"
},
"type" : "DELIVERY",
"serviceName" : "serviceName",
"shipments" : [ {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
}, {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
} ],
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ],
"courier" : {
"vehicleDescription" : "vehicleDescription",
"phone" : "phone",
"phoneExtension" : "phoneExtension",
"fullName" : "fullName",
"vehicleNumber" : "vehicleNumber"
},
"price" : 5.025004791520295,
"outletStorageLimitDate" : "23-09-2022",
"eacType" : "MERCHANT_TO_COURIER",
"liftPrice" : 8.762042012749001,
"eacCode" : "eacCode",
"id" : "id",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"deliveryPartnerType" : "SHOP",
"outletCode" : "outletCode"
},
"notes" : "notes",
"substatus" : "RESERVATION_EXPIRED",
"deliveryTotal" : 1.4658129805029452,
"buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
"creationDate" : "23-09-2022 09:12:41",
"buyerItemsTotal" : 5.962133916683182,
"paymentType" : "PREPAID",
"buyer" : {
"lastName" : "lastName",
"firstName" : "firstName",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"expiryDate" : "23-09-2022 09:12:41",
"buyerTotalBeforeDiscount" : 7.061401241503109,
"itemsTotal" : 6.027456183070403,
"buyerTotal" : 5.637376656633329,
"subsidies" : [ {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
} ],
"paymentMethod" : "CASH_ON_DELIVERY",
"currency" : "RUR",
"fake" : true,
"id" : 0,
"taxSystem" : "OSN",
"cancelRequested" : true,
"items" : [ {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
}, {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
} ],
"status" : "PLACING",
"updatedAt" : "23-09-2022 09:12:41"
}, {
"delivery" : {
"dispatchType" : "UNKNOWN",
"address" : {
"country" : "country",
"city" : "city",
"postcode" : "postcode",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"house" : "house",
"subway" : "subway",
"phone" : "phone",
"street" : "street",
"district" : "district",
"recipient" : "recipient",
"entryphone" : "entryphone",
"block" : "block",
"entrance" : "entrance",
"floor" : "floor",
"apartment" : "apartment"
},
"liftType" : "NOT_NEEDED",
"deliveryServiceId" : 6,
"estimated" : true,
"dates" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022",
"fromTime" : "fromTime",
"toTime" : "toTime",
"realDeliveryDate" : "23-09-2022"
},
"type" : "DELIVERY",
"serviceName" : "serviceName",
"shipments" : [ {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
}, {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
} ],
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ],
"courier" : {
"vehicleDescription" : "vehicleDescription",
"phone" : "phone",
"phoneExtension" : "phoneExtension",
"fullName" : "fullName",
"vehicleNumber" : "vehicleNumber"
},
"price" : 5.025004791520295,
"outletStorageLimitDate" : "23-09-2022",
"eacType" : "MERCHANT_TO_COURIER",
"liftPrice" : 8.762042012749001,
"eacCode" : "eacCode",
"id" : "id",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"deliveryPartnerType" : "SHOP",
"outletCode" : "outletCode"
},
"notes" : "notes",
"substatus" : "RESERVATION_EXPIRED",
"deliveryTotal" : 1.4658129805029452,
"buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
"creationDate" : "23-09-2022 09:12:41",
"buyerItemsTotal" : 5.962133916683182,
"paymentType" : "PREPAID",
"buyer" : {
"lastName" : "lastName",
"firstName" : "firstName",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"expiryDate" : "23-09-2022 09:12:41",
"buyerTotalBeforeDiscount" : 7.061401241503109,
"itemsTotal" : 6.027456183070403,
"buyerTotal" : 5.637376656633329,
"subsidies" : [ {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
} ],
"paymentMethod" : "CASH_ON_DELIVERY",
"currency" : "RUR",
"fake" : true,
"id" : 0,
"taxSystem" : "OSN",
"cancelRequested" : true,
"items" : [ {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
}, {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
} ],
"status" : "PLACING",
"updatedAt" : "23-09-2022 09:12:41"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о заказах.
GetOrdersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/stats/orders
Детальная информация по заказам (getOrdersStats)
Возвращает информацию по заказам на Маркете, в которых есть ваши товары. С помощью нее вы можете собрать статистику по вашим заказам и узнать, например, какие из товаров чаще всего возвращаются покупателями, какие, наоборот, пользуются большим спросом, какая комиссия начисляется за заказы и т. п.
{% note info "" %}
Раньше генерация детальной информации по заказам называлась Отчет по заказам. Сейчас это новый отчет. Подробнее об отчете
{% endnote %}
В одном запросе можно получить информацию не более чем по 200 заказам.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"orders" : [ {
"partnerOrderId" : "partnerOrderId",
"commissions" : [ {
"actual" : 1.2315135367772556,
"type" : "FEE"
}, {
"actual" : 1.2315135367772556,
"type" : "FEE"
} ],
"statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
"payments" : [ {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
}, {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
} ],
"fake" : true,
"deliveryRegion" : {
"name" : "name",
"id" : 6
},
"id" : 0,
"creationDate" : "2000-01-23",
"items" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"initialItems" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"status" : "CANCELLED_BEFORE_PROCESSING",
"paymentType" : "CREDIT"
}, {
"partnerOrderId" : "partnerOrderId",
"commissions" : [ {
"actual" : 1.2315135367772556,
"type" : "FEE"
}, {
"actual" : 1.2315135367772556,
"type" : "FEE"
} ],
"statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
"payments" : [ {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
}, {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
} ],
"fake" : true,
"deliveryRegion" : {
"name" : "name",
"id" : 6
},
"id" : 0,
"creationDate" : "2000-01-23",
"items" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"initialItems" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"status" : "CANCELLED_BEFORE_PROCESSING",
"paymentType" : "CREDIT"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация по заказам.
GetOrdersStatsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offer-prices
Список цен (getPrices)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST campaigns/{campaignId}/offer-prices.
{% endnote %}
Возвращает список цен, установленных вами на товары любым способом: например, через партнерский API или в файле с каталогом.
{% note info %}
Общее количество товаров считается по данным за последние семь дней (не включая сегодня) и не может быть выше 2 миллионов.
{% endnote %}
Способы установки цен описаны в Справке Маркета для продавцов.
|⚙️ Лимит: (количество товаров партнера на витрине) * 25 товаров в сутки|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
archived (optional)
Query Parameter — Фильтр по нахождению в архиве. default: false
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"marketSku" : 0,
"id" : "id",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"marketSku" : 0,
"id" : "id",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"total" : 6,
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список всех товаров с установленными ценами.
GetPricesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-prices
Просмотр цен на указанные товары в магазине (getPricesByOfferIds)
Возвращает список цен на указанные товары в магазине.
{% note warning "Метод только для отдельных магазинов" %}
Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.
Для просмотра базовых цен используйте POST businesses/{businessId}/offer-mappings.
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"offerId" : "offerId",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"offerId" : "offerId",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров с установленными для заданного магазина ценами.
GetPricesByOfferIdsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos/offers
Получение списка товаров, которые участвуют или могут участвовать в акции (getPromoOffers)
Возвращает список товаров, которые участвуют или могут участвовать в акции.
{% note warning %}
В параметре limit не передавайте значение больше 500.
{% endnote %}
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"offerId" : "offerId",
"params" : {
"discountParams" : {
"promoPrice" : 6,
"maxPromoPrice" : 1,
"price" : 0
},
"promocodeParams" : {
"maxPrice" : 5
}
},
"status" : "AUTO",
"autoParticipatingDetails" : {
"campaignIds" : [ 5, 5 ]
}
}, {
"offerId" : "offerId",
"params" : {
"discountParams" : {
"promoPrice" : 6,
"maxPromoPrice" : 1,
"price" : 0
},
"promocodeParams" : {
"maxPrice" : 5
}
},
"status" : "AUTO",
"autoParticipatingDetails" : {
"campaignIds" : [ 5, 5 ]
}
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров, которые участвуют или могут участвовать в акции.
GetPromoOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos
Получение списка акций (getPromos)
Возвращает информацию об акциях Маркета.
По умолчанию возвращаются акции, в которых продавец участвует или может принять участие.
Чтобы получить текущие или завершенные акции, передайте параметр participation.
Типы акций, которые возвращаются в ответе:
- прямая скидка;
- флеш-акция;
- скидка по промокоду.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"promos" : [ {
"period" : {
"dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
"dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
},
"channels" : [ "{}", "{}" ],
"mechanicsInfo" : {
"promocodeInfo" : {
"promocode" : "promocode",
"discount" : 1
},
"type" : "DIRECT_DISCOUNT"
},
"bestsellerInfo" : {
"bestseller" : true,
"entryDeadline" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "name",
"participating" : true,
"id" : "id",
"constraints" : {
"warehouseIds" : [ 5, 5 ]
},
"assortmentInfo" : {
"activeOffers" : 0,
"processing" : true,
"potentialOffers" : 6
}
}, {
"period" : {
"dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
"dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
},
"channels" : [ "{}", "{}" ],
"mechanicsInfo" : {
"promocodeInfo" : {
"promocode" : "promocode",
"discount" : 1
},
"type" : "DIRECT_DISCOUNT"
},
"bestsellerInfo" : {
"bestseller" : true,
"entryDeadline" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "name",
"participating" : true,
"id" : "id",
"constraints" : {
"warehouseIds" : [ 5, 5 ]
},
"assortmentInfo" : {
"activeOffers" : 0,
"processing" : true,
"potentialOffers" : 6
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список акций Маркета.
GetPromosResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/ratings/quality/details
Заказы, которые повлияли на индекс качества (getQualityRatingDetails)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"affectedOrders" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"orderId" : 0,
"description" : "description"
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"orderId" : 0,
"description" : "description"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о заказах, которые повлияли на индекс качества.
GetQualityRatingDetailsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/ratings/quality
Индекс качества магазинов (getQualityRatings)
Возвращает значение индекса качества магазинов и его составляющие.
Подробнее об индексе качества читайте в Справке Маркета для продавцов.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"campaignRatings" : [ {
"campaignId" : 0,
"ratings" : [ {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
}, {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
} ]
}, {
"campaignId" : 0,
"ratings" : [ {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
}, {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Значение индекса качества магазинов и его составляющие.
GetQualityRatingResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /reports/info/{reportId}
Получение заданного отчета (getReportInfo)
Возвращает статус генерации заданного отчета и, если отчет готов, ссылку для скачивания.
Чтобы воспользоваться этим запросом, вначале нужно запустить генерацию отчета. Инструкция
|⚙️ Лимит: 100 запросов в минуту|
|-|
Path parameters
reportId (required)
Path Parameter — Идентификатор отчета, который вы получили после запуска генерации. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"generationRequestedAt" : "2000-01-23T04:56:07.000+00:00",
"file" : "file",
"generationFinishedAt" : "2000-01-23T04:56:07.000+00:00",
"subStatus" : "NO_DATA",
"status" : "PENDING",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Статус генерации отчета и ссылка, если она уже есть.
{% note tip %}
Если статус генерации отчета — FAILED или NO_DATA, проверьте корректность запроса на генерацию. Например, верно ли указан идентификатор магазина, период или номер платежного поручения.
{% endnote %}
GetReportInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}
Информация о невыкупе или возврате (getReturn)
Получает информацию по одному невыкупу или возврату.
|⚙️ Лимит: 10 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"updateDate" : "2000-01-23T04:56:07.000+00:00",
"fastReturn" : true,
"orderId" : 6,
"shipmentRecipientType" : "SHOP",
"refundStatus" : "STARTED_BY_USER",
"logisticPickupPoint" : {
"logisticPartnerId" : 5,
"address" : {
"country" : "Россия",
"city" : "Москва",
"street" : "Стрелецкая улица",
"postcode" : "123518",
"house" : "9к2"
},
"instruction" : "instruction",
"name" : "name",
"id" : 1,
"type" : "WAREHOUSE"
},
"id" : 0,
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"items" : [ {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
}, {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
} ],
"returnType" : "UNREDEEMED",
"shipmentStatus" : "CREATED",
"refundAmount" : 5
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Детали возврата.
GetReturnResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/application
Получение заявления на возврат (getReturnApplication)
Загружает заявление покупателя на возврат товара.
|⚙️ Лимит: 10 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/octet-streamapplication/json
Responses
200
Заявление на возврат.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}
Получение фотографии возврата (getReturnPhoto)
Получает фотографии, которые покупатель приложил к заявлению на возврат товара.
|⚙️ Лимит: 10 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
itemId (required)
Path Parameter — Идентификатор товара в возврате. default: null format: int64
imageHash (required)
Path Parameter — Хеш ссылки изображения для загрузки. default: null
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/octet-streamapplication/json
Responses
200
Фотография возврата.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/returns
Список невыкупов и возвратов (getReturns)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
orderIds (optional)
Query Parameter —
Идентификаторы заказов — для фильтрации результатов.
Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
default: null format: int64
statuses (optional)
Query Parameter —
Статусы возвратов или невыкупов — для фильтрации результатов.
Несколько статусов перечисляются через запятую.
default: null
type (optional)
Query Parameter —
Тип заказа для фильтрации:
-
RETURN — возврат.
-
UNREDEEMED — невыкуп.
Если не указывать, в ответе будут и возвраты, и невыкупы.
default: null
fromDate (optional)
Query Parameter —
Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
Формат: ГГГГ-ММ-ДД.
default: null format: date
toDate (optional)
Query Parameter —
Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
Формат: ГГГГ-ММ-ДД.
default: null format: date
from_date (optional)
Query Parameter —
{% note warning "" %}
Этот параметр устарел. Вместо него используйте fromDate.
{% endnote %}
Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
default: null format: date
to_date (optional)
Query Parameter —
{% note warning "" %}
Этот параметр устарел. Вместо него используйте toDate.
{% endnote %}
Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
default: null format: date
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"nextPageToken" : "nextPageToken"
},
"returns" : [ {
"updateDate" : "2000-01-23T04:56:07.000+00:00",
"fastReturn" : true,
"orderId" : 6,
"shipmentRecipientType" : "SHOP",
"refundStatus" : "STARTED_BY_USER",
"logisticPickupPoint" : {
"logisticPartnerId" : 5,
"address" : {
"country" : "Россия",
"city" : "Москва",
"street" : "Стрелецкая улица",
"postcode" : "123518",
"house" : "9к2"
},
"instruction" : "instruction",
"name" : "name",
"id" : 1,
"type" : "WAREHOUSE"
},
"id" : 0,
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"items" : [ {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
}, {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
} ],
"returnType" : "UNREDEEMED",
"shipmentStatus" : "CREATED",
"refundAmount" : 5
}, {
"updateDate" : "2000-01-23T04:56:07.000+00:00",
"fastReturn" : true,
"orderId" : 6,
"shipmentRecipientType" : "SHOP",
"refundStatus" : "STARTED_BY_USER",
"logisticPickupPoint" : {
"logisticPartnerId" : 5,
"address" : {
"country" : "Россия",
"city" : "Москва",
"street" : "Стрелецкая улица",
"postcode" : "123518",
"house" : "9к2"
},
"instruction" : "instruction",
"name" : "name",
"id" : 1,
"type" : "WAREHOUSE"
},
"id" : 0,
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"items" : [ {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
}, {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
} ],
"returnType" : "UNREDEEMED",
"shipmentStatus" : "CREATED",
"refundAmount" : 5
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Постраничные возвраты партнера.
GetReturnsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers/stocks
Информация об остатках и оборачиваемости (getStocks)
Возвращает данные об остатках товаров (для всех моделей) и об оборачиваемости товаров (для модели FBY).
{% note info "По умолчанию данные по оборачивамости не возращаются" %}
Чтобы они были в ответе, передавайте true в поле withTurnover.
{% endnote %}
|⚙️ Лимит: 100 000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"warehouses" : [ {
"offers" : [ {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"warehouseId" : 0
}, {
"offers" : [ {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"warehouseId" : 0
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Остатки товаров на складах.
GetWarehouseStocksResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-mapping-entries/suggestions
Рекомендованные карточки для товаров (getSuggestedOfferMappingEntries)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/suggestions.
{% endnote %}
Возвращает идентификаторы карточек товаров на Маркете, рекомендованных для ваших товаров.
Каждому товару, который вы размещаете, должна соответствовать карточка товара на Маркете со своим идентификатором — SKU на Маркете. Он указывается в URL карточки товара, после «...sku=», например:
##https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016…##
Чтобы получить для товаров рекомендованные SKU на Маркете, передайте в теле POST-запроса как можно больше информации о них: названия, производителей, штрихкоды, цены и т. д.
Полученные SKU можно передать вместе с информацией о ваших товарах с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/updates.
В одном запросе можно получить не более 500 рекомендаций.
|⚙️ Лимит: 100 000 рекомендаций в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"marketCategoryId" : 4,
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"marketModelId" : 7,
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"marketSkuName" : "marketSkuName",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"marketModelName" : "marketModelName",
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"marketCategoryName" : "marketCategoryName",
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
}, {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"marketCategoryId" : 4,
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"marketModelId" : 7,
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"marketSkuName" : "marketSkuName",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"marketModelName" : "marketModelName",
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"marketCategoryName" : "marketCategoryName",
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о товарах в каталоге.
GetSuggestedOfferMappingEntriesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/suggestions
Просмотр карточек на Маркете, которые подходят вашим товарам (getSuggestedOfferMappings)
Возвращает идентификаторы карточек на Маркете, которые соответствуют товарам с заданными параметрами.
Пользоваться этим запросом необязательно: он просто помогает заранее убедиться, что Маркет верно определяет карточки по предоставленным вами данным.
Как пользоваться запросом
- Передайте Маркету список товаров, которые нужно проверить.
- В ответ вы получите список SKU на Маркете с расшифровкой: названием, идентификатором модели, категорией.
- Если расшифровки мало, вы можете открыть карточку. Для этого перейдите по ссылке вида
https://market.yandex.ru/product/<marketModelId>?sku=<marketSku>.
- Если карточка соответствует товару, значит его можно добавлять в каталог с теми данными, что вы указали. Если карточка определилась неправильно — проверьте данные о товаре. Возможно, их нужно уточнить или дополнить. Кроме того, на этапе добавления товара вы можете указать
marketSKU, который ему подходит по вашему мнению.
{% note info "𝓠 Как определить marketSku товара, найденного на Маркете?" %}
𝓐 Он есть в адресе страницы товара — расположен после sku=.
Например, https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016
{% endnote %}
|⚙️ Лимит: 100 000 товаров в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"offer" : {
"vendor" : "LEVENHUK",
"basicPrice" : {
"value" : 0.9301444243932576
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"description" : "description",
"category" : "category",
"barcodes" : [ "46012300000000", "46012300000000" ],
"vendorCode" : "VNDR-0005A"
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
}, {
"offer" : {
"vendor" : "LEVENHUK",
"basicPrice" : {
"value" : 0.9301444243932576
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"description" : "description",
"category" : "category",
"barcodes" : [ "46012300000000", "46012300000000" ],
"vendorCode" : "VNDR-0005A"
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Подобранные карточки на Маркете.
По результатам проверки товара полученная через этот запрос карточка может быть заменена на другую.
GetSuggestedOfferMappingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-prices/suggestions
Цены для продвижения товаров (getSuggestedPrices)
{% note warning "" %}
Этот метод устарел. Вместо него используйте отчет «Цены на рынке».
{% endnote %}
{% note warning "" %}
Этот метод подходит только тем магазинам, которые устанавливают цены на товары в рублях.
{% endnote %}
Возвращает цены для продвижения товаров, которые вы размещаете на Маркете.
Товары, для которых нужно получить цены, передаются в теле POST-запроса.
Цены для продвижения зависят от цен, установленных на товары другими партнерами. Если один товар поставляют несколько партнеров, на Маркете сначала продается товар с более низкой ценой. Когда закончится товар по низкой цене, начнет продаваться товар по более высокой цене.
Выходные данные содержат для каждого товара несколько цен, соответствующих разным типам продвижения.
Установить цены на товары можно с помощью запроса POST campaigns/{campaignId}/offer-prices/updates или другими способами: например, указать их в файле с каталогом. Также вы можете использовать стратегии для автоматической установки рекомендованных цен или минимальных цен на Маркете.
Подробно об автоматическом управлении ценами рассказано в Справке Маркета для продавцов.
|⚙️ Лимит: 100 000 товаров в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"marketSku" : 0,
"offerId" : "offerId",
"priceSuggestion" : [ {
"price" : 6.027456183070403,
"type" : "BUYBOX"
}, {
"price" : 6.027456183070403,
"type" : "BUYBOX"
} ]
}, {
"marketSku" : 0,
"offerId" : "offerId",
"priceSuggestion" : [ {
"price" : 6.027456183070403,
"type" : "BUYBOX"
}, {
"price" : 6.027456183070403,
"type" : "BUYBOX"
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список цен для продвижения на Маркете.
SuggestPricesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /businesses/{businessId}/warehouses
Список складов и групп складов (getWarehouses)
Возвращает список складов и, если склады объединены, список групп складов. Что такое группы складов и зачем они нужны
Среди прочего запрос позволяет определить идентификатор, который нужно использовать при передаче остатков для группы складов.
|⚙️ Лимит: 100 запросов в минуту|
|-|
Path parameters
Return type
Example data
Content-Type: application/json
{
"result" : {
"warehouses" : [ {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}, {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
} ],
"warehouseGroups" : [ {
"name" : "name",
"warehouses" : [ {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}, {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
} ],
"mainWarehouse" : {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}
}, {
"name" : "name",
"warehouses" : [ {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}, {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
} ],
"mainWarehouse" : {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список складов и групп складов.
GetWarehousesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/identifiers
Передача кодов маркировки единиц товара (provideOrderItemIdentifiers)
{% note warning "Этот запрос только для DBS" %}
Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.
{% endnote %}
Передает Маркету коды маркировки для единиц товара в указанном заказе.
Принимаются коды следующих типов:
- Коды «Честного знака».
- УИН для ювелирных изделий.
- РНПТ и ГТД для импортных прослеживаемых товаров.
{% note warning %}
Прежде чем работать с этим методом, обязательно прочтите статью о работе с маркируемыми товарами.
{% endnote %}
Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"items" : [ {
"offerName" : "offerName",
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"price" : 1.4658129805029452,
"vat" : "NO_VAT",
"count" : 6,
"offerId" : "offerId",
"id" : 0
}, {
"offerName" : "offerName",
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"price" : 1.4658129805029452,
"vat" : "NO_VAT",
"count" : 6,
"offerId" : "offerId",
"id" : 0
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ 200 обозначает, что коды успешно записались. Ответ содержит краткие сведения о промаркированных товарах.
ProvideOrderItemIdentifiersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /businesses/{businessId}/bids
Включение буста продаж и установка ставок (putBidsForBusiness)
Запускает буст продаж — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.
{% cut "Как в кабинете выглядит кампания, созданная через API" %}
{% endcut %}
При первом использовании запроса Маркет: создаст единую на все магазины бизнес-аккаунта кампанию, добавит в нее товары с указанными ставками, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.
Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.
Запрос всегда работает с одной и той же созданной через API кампанией. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. Другими кампаниями управлять через API не получится. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.
Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.
Внести другие изменения в созданную через API кампанию можно в кабинете:
- выключить или включить кампанию;
- изменить ее название;
- выключить или включить ценовую стратегию.
Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.
Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.
{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}
𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.
{% endnote %}
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Все получилось: ставки установлены или обновлены. Если нужно, добавлены новые товары и запущена кампания.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/bids
Включение буста продаж и установка ставок для магазина (putBidsForCampaign)
Запускает буст продаж в указанном магазине — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.
При первом использовании запроса Маркет: создаст кампанию, добавит в нее товары с указанными ставками для заданного магазина, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.
Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.
Запрос всегда работает с одной и той же кампанией, созданной через этот запрос или PUT businesses/{businessId}/bids. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.
Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.
Внести другие изменения в созданную через API кампанию можно в кабинете:
- выключить или включить кампанию;
- изменить ее название;
- выключить или включить ценовую стратегию.
Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.
Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.
{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}
𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.
{% endnote %}
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/feeds/{feedId}/refresh
Сообщить, что прайс-лист обновился (refreshFeed)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет сообщить, что магазин обновил прайс-лист. После этого Маркет начнет обновление данных на сервисе.
- Магазин обновляет прайс-лист, ссылку на который он указал в кабинете.
- Магазин отправляет Маркету запрос методом
POST campaigns/{campaignId}/feeds/{feedId}/refresh.
- Маркет начинает обновление данных магазина на сервисе.
{% note alert %}
Запрос работает только для включенных магазинов. Если магазин выключен, данные на Маркете не обновятся, даже если HTTP-код — 200 OK. Проверить статус магазина можно с помощью базовых запросов или на странице бизнес-аккаунта.
{% endnote %}
|⚙️ Лимит: 3 запроса в час для одного прайс-листа|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /regions/{regionId}/children
Информация о дочерних регионах (searchRegionChildren)
Возвращает информацию о регионах, являющихся дочерними по отношению к региону, идентификатор которого указан в запросе.
Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).
Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.
|⚙️ Лимит: 50 000 запросов в час|
|-|
Path parameters
regionId (required)
Path Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
Query parameters
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"regions" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Регионы, являющиеся дочерними к указанному в запросе.
GetRegionWithChildrenResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /regions/{regionId}
Информация о регионе (searchRegionsById)
Возвращает информацию о регионе.
Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).
Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.
|⚙️ Лимит: 50 000 запросов в час|
|-|
Path parameters
regionId (required)
Path Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"regions" : [ {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}, {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Найденный регион.
GetRegionsResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Поиск регионов по их имени (searchRegionsByName)
Возвращает информацию о регионе, удовлетворяющем заданным в запросе условиям поиска.
Если найдено несколько регионов, удовлетворяющих условиям поиска, возвращается информация по каждому найденному региону (но не более десяти регионов) для возможности определения нужного региона по родительским регионам.
Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).
Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.
|⚙️ Лимит: 50 000 запросов в час|
|-|
Query parameters
name (required)
Query Parameter —
Название региона.
Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, Москва.
default: null
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"regions" : [ {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}, {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список найденных регионов.
GetRegionsResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/file/send
Отправка файла в чат (sendFileToChat)
Отправляет файл в чат с покупателем.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Query parameters
chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
Form parameters
file (required)
Form Parameter — Содержимое файла. Максимальный размер файла — 5 Мбайт. default: null format: binary
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ. Означает, что файл отправлен.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/message
Отправка сообщения в чат (sendMessageToChat)
Отправляет сообщение в чат с покупателем.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ. Означает, что сообщение отправлено.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/feeds/{feedId}/params
Изменение параметров прайс-листа (setFeedParams)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет магазину изменить параметры прайс-листа.
Чтобы отредактировать параметр прайс-листа, передайте в теле запроса: name (название параметра) и value (значение параметра).
Чтобы отменить установленное значение, передайте в теле запроса: name (название параметра) и delete=true (удалить значение).
|⚙️ Лимит: 3 запроса в час для одного прайс-листа|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Статус выполнения операции.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/boxes
Подготовка заказа (setOrderBoxLayout)
{% note tip "Подходит и для DBS" %}
Запрос предназначен для работы с FBS-заказами, но вы можете использовать его для обработки DBS-заказов, если это удобно.
{% endnote %}
Позволяет выполнить три операции:
- передать Маркету информацию о распределении товаров по коробкам;
- передать Маркету коды маркировки для товаров;
- удалить товар из заказа, если его не оказалось на складе.
Если нужно что-то поправить в переданных данных, просто повторите запрос — это можно делать сколько угодно раз до перевода заказа в статус Готов к отгрузке. ⚠️ Если вы меняете раскладку уже после печати и расклейки ярлыков, не забудье перепечатать их и наклеить заново.
Как передать информацию о распределении товаров
В этом запросе вам нужно передать Маркету список коробок и указать, какие именно товары лежат в каждой из них. Коробки могут быть двух типов:
-
Содержащие товары целиком. Такая коробка может содержать сколько угодно единиц любых товаров.
-
Содержащие часть товара. Такие коробки содержат по одной части одного товара. Например, одна содержит внешний блок кондиционера, а другая — внутренний блок.
⚠️ Одна коробка не может содержать и товары целиком, и части товаров.
Как передавать коды маркировки
Если в заказе есть товары, подлежащие маркировке, в запросе нужно передать соответствующие уникальные коды. Что такое маркировка?
Принимаются коды следующих типов:
- Коды «Честного знака».
- УИН для ювелирных изделий.
- РНПТ и ГТД для импортных прослеживаемых товаров.
Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй.
Если товар едет в нескольких коробках, код маркировки нужно передать для каждой из них.
Как удалить товар из заказа
Чтобы удалить товар из заказа:
- Добавьте в запрос
allowRemove: true.
- Передайте распределение по коробкам без товара, который нужно удалить.
{% note warning "Удаление нельзя отменить" %}
Эта операция необратима: покупатель сразу получит уведомление, а состав заказа изменится.
{% endnote %}
Чтобы удалить позицию целиком, не передавайте соответствующий OrderBoxLayoutItemDTO. Чтобы уменьшить количество товара, передайте уменьшенное значение в поле fullCount.
Нельзя удалить или уменьшить количество товара, если он:
- добавлен по акции;
- составляет 99% стоимости заказа;
- единственный товар в заказе.
Если вы не можете отгрузить такой товар, отмените заказ. Для этого отправьте запрос методом PUT campaigns/{campaignId}/orders/{orderId}/status и передайте статус заказа CANCELLED с причиной отмены SHOP_FAILED.
{% note info "Увеличить заказ нельзя" %}
С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим.
{% endnote %}
Примеры
{% cut "Товар умещается в коробку" %}
Вот как будет выглядеть запрос, если в одной коробке едут:
- три единицы одного товара, требующего маркировки;
- одна единица другого товара, не требущего маркировки.
{
"boxes": [
{
"items": [
{
"id": 123456,
"fullCount": 3,
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
},
{
"cis": "010304109478gftJ14545762!\u001dhGt264"
},
{
"cis": "010304109478fRs28323ks23!\u001dhet201"
}
]
},
{
"id": 654321,
"fullCount": 1
}
]
}
]
}
{% endcut %}
{% cut "Товар едет в разных коробках" %}
Вот как будет выглядеть запрос, если товар едет в двух коробках:
{
"boxes": [
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 2,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
}
]
}
{% endcut %}
{% cut "Одинаковые товары, где каждый едет в нескольких коробках" %}
Вот как будет выглядеть запрос, если каждый из двух одинаковых товаров едет в двух коробках:
{
"boxes": [
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 2,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 2,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
}
]
}
{% endcut %}
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"boxes" : [ {
"items" : [ {
"partialCount" : {
"current" : 1,
"total" : 2
},
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
} ],
"id" : 0,
"fullCount" : 1
}, {
"partialCount" : {
"current" : 1,
"total" : 2
},
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
} ],
"id" : 0,
"fullCount" : 1
} ],
"boxId" : 5
}, {
"items" : [ {
"partialCount" : {
"current" : 1,
"total" : 2
},
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
} ],
"id" : 0,
"fullCount" : 1
}, {
"partialCount" : {
"current" : 1,
"total" : 2
},
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
} ],
"id" : 0,
"fullCount" : 1
} ],
"boxId" : 5
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ придет переданная раскладка с идентификаторами коробок — они понадобятся для запроса ярлыков.
SetOrderBoxLayoutResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes
Передача количества грузовых мест в заказе (setOrderShipmentBoxes)
{% note warning "Этот запрос только для DBS" %}
Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.
{% endnote %}
Отгружаемый Маркету заказ может не влезть в одну коробку или упаковку — в этом случае получается, что он занимает несколько грузовых мест.
Количество грузовых мест нужно обязательно передавать Маркету, если оно не равно 1. Это делается перед переводом его в статус Готов к отгрузке. Подробно о том, что в какой момент нужно передавать, рассказано в пошаговой инструкции.
Метод устроен немного нестандартно: количество задается длиной массива пустых объектов.
Раньше метод требовал передачи большего количества данных. Запросы, оформленные по старому образцу, работают, но лучше делать по-новому.
{% cut "Как было раньше" %}
Структура тела PUT-запроса:
{
"boxes":
[
{
"fulfilmentId": "{string}",
"weight": {int64},
"width": {int64},
"height": {int64},
"depth": {int64},
"items":
[
{
"id": {int64},
"count": {int32}
},
...
]
},
...
]
}
| Параметр | Тип | Значение |
| ----------- | ----------- | ----------- |
| boxes | | Список грузовых мест. |
Параметры, вложенные в boxes
| Параметр | Тип | Значение |
| ----------- | ----------- | ----------- |
| fulfilmentId | String | Идентификатор грузового места в информационной системе магазина. Сформируйте идентификатор по шаблону: номер заказа на Маркете-номер грузового места. Например, 7206821‑1, 7206821‑2 и т. д. |
| weight | Int64 | Масса брутто грузового места (суммарная масса упаковки и содержимого) в граммах. |
| width | Int64 | Ширина грузового места в сантиметрах. |
| height | Int64 | Высота грузового места в сантиметрах. |
| depth | Int64 | Глубина грузового места в сантиметрах. |
| items | Int64 | Список товаров в грузовом месте. |
Параметры, вложенные в items
| Параметр | Тип | Значение |
| ----------- | ----------- | ----------- |
| id | Int64 | Идентификатор товара в рамках заказа. |
| count | Int32 | Количество единиц товара в грузовом месте. |
{% endcut %}
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
shipmentId (required)
Path Parameter — Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 0
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 0
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Имеет значение только тип ответа. Если ответ
ОК, количество грузомест записано.
SetOrderShipmentBoxesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/skip-reaction
Отказ от ответа на отзывы (skipGoodsFeedbacksReaction)
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-prices/updates
Установка цен на товары во всех магазинах (updateBusinessPrices)
Устанавливает базовые цены. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Маркет принял информацию о новых ценах.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers/update
Изменение условий продажи товаров в магазине (updateCampaignOffers)
Изменяет параметры продажи товаров в конкретном магазине: доступность товара, условия доставки и самовывоза, применяемую ставку НДС.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ 200 обозначает, что новые параметры получены Маркетом и скоро вступят в силу.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/comments/update
Добавление нового или изменение созданного комментария (updateGoodsFeedbackComment)
Добавляет новый комментарий магазина или изменяет комментарий, который магазин оставлял ранее.
Для создания комментария к отзыву передайте только идентификатор отзыва feedbackId.
Чтобы добавить комментарий к другому комментарию, передайте:
feedbackId — идентификатор отзыва;comment.parentId — идентификатор родительского комментария.
Чтобы изменить комментарий, передайте:
feedbackId— идентификатор отзыва;comment.id — идентификатор комментария, который нужно изменить.
Если передать одновременно comment.parentId и comment.id, будет изменен существующий комментарий.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 0,
"text" : "text",
"canModify" : true,
"parentId" : 6,
"status" : "PUBLISHED"
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о добавленном или измененном комментарии.
UpdateGoodsFeedbackCommentResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-cards/update
Редактирование категорийных характеристик товара (updateOfferContent)
Редактирует характеристики товара, которые специфичны для категории, к которой он относится.
{% note warning "Здесь только то, что относится к конкретной категории" %}
Если вам нужно изменить основные параметры товара (название, описание, изображения, видео, производитель, штрихкод), воспользуйтесь запросом POST businesses/{businessId}/offer-mappings/update.
{% endnote %}
Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"results" : [ {
"warnings" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ]
}, {
"warnings" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ]
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Запрос выполнен корректно, данные обработаны.
{% note warning "Ответ 200 сам по себе не значит, что переданные значения корректны" %}
Обязательно посмотрите детали ответа: status и перечень ошибок, если он есть.
Даже если ошибка допущена в характеристиках всего одного товара, никакие изменения из запроса в каталог не попадут.
{% endnote %}
Если в status вернулось ERROR, убедитесь, что:
- все обязательные характеристики заполнены;
- характеристики действительно существуют в указанных категориях;
- значения соответствуют характеристикам;
- ваши собственные значения имеют нужный тип данных.
Найти проблемы помогут поля errors и warnings.
UpdateOfferContentResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-mapping-entries/updates
Добавление и редактирование товаров в каталоге (updateOfferMappingEntries)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/update.
{% endnote %}
Добавляет товары, указанные в запросе, в ваш каталог товаров и редактирует уже имеющиеся товары.
Информацию о товарах нужно передать в теле POST-запроса.
У каждого товара должен быть ваш SKU — уникальный код, который вы используете для идентификации товара:
- Чтобы добавить в каталог новый товар, укажите в параметре
shopSku ваш SKU, которого еще нет в каталоге.
- Чтобы отредактировать товар из каталога, укажите в параметре
shopSku ваш SKU этого товара в каталоге.
В обоих случаях в запросе нужно передать полное описание товара, даже если вы хотите изменить только несколько характеристик.
Если вы знаете, какой карточке товара на Маркете соответствует ваш товар, укажите ее идентификатор (SKU на Маркете) во входном параметре mapping. Получить SKU на Маркете рекомендованной карточки товара можно с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/suggestions или через кабинет. Если SKU на Маркете не указан, сотрудники Маркета сами подберут или создадут подходящую карточку товара, либо у него появится статус NEED_CONTENT (нужно найти карточку или создать ее самостоятельно) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.
Перед публикацией товары проходят модерацию. Если в одном из отправленных товаров найдена ошибка, ответ на запрос будет иметь HTTP-код 400 Bad Request, и ни один из товаров не отправится на модерацию. При этом если вы не передадите все обязательные параметры для какого‑либо товара, после модерации у него появится статус NEED_INFO (в описании товара не хватает информации) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.
В одном запросе можно добавить не более 500 товаров.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5 000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Статус выполнения операции.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/update
Добавление товаров в каталог и изменение информации о них (updateOfferMappings)
Добавляет товары в каталог, передает их категории на Маркете и характеристики, необходимые для этих категории. Также редактирует информацию об уже имеющихся товарах.
Список категорий Маркета можно получить с помощью запроса POST categories/tree, а характеристики товаров по категориям с помощью POST category/{categoryId}/parameters.
Чтобы добавить новый товар, передайте его с новым идентификатором, который раньше никогда не использовался в каталоге. Старайтесь сразу передать как можно больше информации — она потребуется Маркету для подбора подходящей карточки или создания новой. Если известно, какой карточке на Маркете соответствует товар, можно сразу указать идентификатор этой карточки (SKU на Маркете) в поле marketSKU.
Для новых товаров обязательно укажите параметры: offerId, name, marketCategoryId или category, pictures, vendor, description.
Чтобы отредактировать информацию о товаре, передайте новые данные, указав в offerId соответствующий ваш SKU. Поля, в которых ничего не меняется, можно не передавать.
Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.
Параметр offerId должен быть уникальным для всех товаров, которые вы передаете.
{% note warning "Правила использования SKU" %}
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
{% endnote %}
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"results" : [ {
"warnings" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ]
}, {
"warnings" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ]
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Все обязательные поля товаров заполнены, поэтому новые товары и внесенные изменения сохранены в каталоге.
UpdateOfferMappingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/items
Удаление товара из заказа или уменьшение числа единиц (updateOrderItems)
{% note warning "Этот запрос только для DBS" %}
Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.
{% endnote %}
Изменяет состав заказа, если позволяет выбранная служба доставки, в случаях:
- покупатель уменьшил количество товара;
- магазин не может поставить все товары в заказе.
Для этого заказ должен находится в статусе "status": "PROCESSING" этапа обработки "substatus": "STARTED". После передачи статуса "substatus": "READY_TO_SHIP" изменить состав невозможно.
Если одинаковых товаров несколько, для уменьшения количества передайте обновленное значение в атрибуте count параметра item.
Чтобы полностью удалить товар из заказа:
- передайте значение
0; или
- не передавайте параметр
item.
Нельзя удалить или уменьшить количество товара, если он:
- добавлен по акции;
- составляет 99% стоимости заказа;
- единственный товар в заказе.
Если необходимо удалить такой товар, отмените заказ. Для этого отправьте запрос методом PUT campaigns/{campaignId}/orders/{orderId}/status и передайте статус заказа CANCELLED с причиной отмены SHOP_FAILED.
{% note info "Увеличить заказ нельзя" %}
С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим.
{% endnote %}
Возврат денег покупателю
Если покупатель оплатил товар при оформлении, Маркет вернет ему деньги за удаленные из заказа товары в течение двух дней:
-
при оплате банковской картой — с момента, когда магазин переведет заказ в статус SHIPPED;
-
при оплате через Apple Pay или Google Pay — с момента, когда магазин удалит товар из заказа.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Маркет успешно обработал ваш запрос. Выходные данные не ожидаются.
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/status
Изменение статуса одного заказа (updateOrderStatus)
Изменяет статус заказа. Возможные изменения статусов:
- Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "STARTED" нужно перевести в статус "status": "PROCESSING" и этап обработки "substatus": "READY_TO_SHIP".
- Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "STARTED" нужно перевести в статус "status": "CANCELLED" с причиной отмены заказа "substatus": "SHOP_FAILED".
- Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "READY_TO_SHIP" нужно перевести в статус "status": "CANCELLED" с причиной отмены заказа "substatus": "SHOP_FAILED".
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"order" : {
"delivery" : {
"dispatchType" : "UNKNOWN",
"address" : {
"country" : "country",
"city" : "city",
"postcode" : "postcode",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"house" : "house",
"subway" : "subway",
"phone" : "phone",
"street" : "street",
"district" : "district",
"recipient" : "recipient",
"entryphone" : "entryphone",
"block" : "block",
"entrance" : "entrance",
"floor" : "floor",
"apartment" : "apartment"
},
"liftType" : "NOT_NEEDED",
"deliveryServiceId" : 6,
"estimated" : true,
"dates" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022",
"fromTime" : "fromTime",
"toTime" : "toTime",
"realDeliveryDate" : "23-09-2022"
},
"type" : "DELIVERY",
"serviceName" : "serviceName",
"shipments" : [ {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
}, {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
} ],
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ],
"courier" : {
"vehicleDescription" : "vehicleDescription",
"phone" : "phone",
"phoneExtension" : "phoneExtension",
"fullName" : "fullName",
"vehicleNumber" : "vehicleNumber"
},
"price" : 5.025004791520295,
"outletStorageLimitDate" : "23-09-2022",
"eacType" : "MERCHANT_TO_COURIER",
"liftPrice" : 8.762042012749001,
"eacCode" : "eacCode",
"id" : "id",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"deliveryPartnerType" : "SHOP",
"outletCode" : "outletCode"
},
"notes" : "notes",
"substatus" : "RESERVATION_EXPIRED",
"deliveryTotal" : 1.4658129805029452,
"buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
"creationDate" : "23-09-2022 09:12:41",
"buyerItemsTotal" : 5.962133916683182,
"paymentType" : "PREPAID",
"buyer" : {
"lastName" : "lastName",
"firstName" : "firstName",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"expiryDate" : "23-09-2022 09:12:41",
"buyerTotalBeforeDiscount" : 7.061401241503109,
"itemsTotal" : 6.027456183070403,
"buyerTotal" : 5.637376656633329,
"subsidies" : [ {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
} ],
"paymentMethod" : "CASH_ON_DELIVERY",
"currency" : "RUR",
"fake" : true,
"id" : 0,
"taxSystem" : "OSN",
"cancelRequested" : true,
"items" : [ {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
}, {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
} ],
"status" : "PLACING",
"updatedAt" : "23-09-2022 09:12:41"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В случае успешного изменения статуса заказа возвращается обновленная информация о заказе.
UpdateOrderStatusResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/status-update
Изменение статусов нескольких заказов (updateOrderStatuses)
Изменяет статусы нескольких заказов.
Возможные изменения статусов:
- Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса
"status": "PROCESSING"и этапа обработки "substatus": "STARTED" нужно перевести в статус "status": "PROCESSING" и этап обработки "substatus": "READY_TO_SHIP".
- Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "STARTED" нужно перевести в статус "status": "CANCELLED" с причиной отмены заказа "substatus": "SHOP_FAILED".
- Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "READY_TO_SHIP" нужно перевести в статус "status": "CANCELLED" с причиной отмены заказа "substatus": "SHOP_FAILED".
Максимальное количество заказов, у которых можно изменить статус в одном запросе, — 30.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"orders" : [ {
"substatus" : "RESERVATION_EXPIRED",
"updateStatus" : "OK",
"id" : 0,
"status" : "PLACING",
"errorDetails" : "errorDetails"
}, {
"substatus" : "RESERVATION_EXPIRED",
"updateStatus" : "OK",
"id" : 0,
"status" : "PLACING",
"errorDetails" : "errorDetails"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Возвращается информация об обновленных статусах заказов.
UpdateOrderStatusesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-prices/updates
Установка цен на товары в конкретном магазине (updatePrices)
Устанавливает цены на товары в магазине. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.
{% note warning "Метод только для отдельных магазинов" %}
Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.
Для управления базовыми ценами используйте POST businesses/{businessId}/offer-prices/updates.
{% endnote %}
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Маркет принял информацию о новых ценах.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos/offers/update
Добавление товаров в акцию или изменение их цен (updatePromoOffers)
Добавляет товары в акцию или изменяет цены на товары, которые участвуют в акции.
Изменения начинают действовать в течение 4–6 часов.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"rejectedOffers" : [ {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
}, {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
} ],
"warningOffers" : [ {
"warnings" : [ {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
}, {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
} ],
"offerId" : "offerId"
}, {
"warnings" : [ {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
}, {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
} ],
"offerId" : "offerId"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Результат добавления товаров в акцию или обновления их цен.
UpdatePromoOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/offers/stocks
Передача информации об остатках (updateStocks)
Передает данные об остатках товаров на витрине.
Обязательно указывайте SKU в точности так, как он указан в каталоге. Например, 557722 и 0557722 — это два разных SKU.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 100 000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/verifyEac
Передача кода подтверждения (verifyOrderEac)
Отправляет Маркету код подтверждения для его проверки.
Код подтверждает передачу заказа или невыкупа:
- курьеру — курьер должен назвать магазину код;
- магазину — магазин называет код курьеру.
Если магазин получает невыкупленный заказ, то ему нужно назвать курьеру код из кабинета или приложения.
Если у магазина настроена работа с кодами подтверждения, в запросах POST order/status, PUT campaigns/{campaignId}/orders/{orderId}/status, GET campaigns/{campaignId}/orders, GET campaigns/{campaignId}/orders/{orderId} в параметре delivery, вложенном в order будет возвращаться параметр eacType с типом Enum — тип кода подтверждения для передачи заказа.
Возможные значения: MERCHANT_TO_COURIER — магазин называет код курьеру, COURIER_TO_MERCHANT — курьер называет код магазину.
Параметр eacType возвращается при статусах заказа COURIER_FOUND, COURIER_ARRIVED_TO_SENDER и DELIVERY_SERVICE_UNDELIVERED. Если заказ в других статусах, параметр может отсутствовать.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"verificationResult" : "ACCEPTED",
"attemptsLeft" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Проверка кода выполнена успешно.
VerifyOrderEacResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/hidden-offers
Скрытие товаров и настройки скрытия (addHiddenOffers)
Скрывает товары магазина на Маркете.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Настройки скрытия получены и скоро вступят в силу.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/archive
Добавление товаров в архив (addOffersToArchive)
Помещает товары в архив. Товары, помещенные в архив, скрыты с витрины во всех магазинах кабинета.
{% note warning "В архив нельзя отправить товар, который хранится на складе Маркета" %}
Вначале такой товар нужно распродать или вывезти.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notArchivedOffers" : [ {
"offerId" : "offerId",
"error" : "OFFER_HAS_STOCKS"
}, {
"offerId" : "offerId",
"error" : "OFFER_HAS_STOCKS"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если некоторые товары добавить в архив не удалось, в ответе 200 будет их список.
Список успешно добавленных товаров не возвращается.
AddOffersToArchiveResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /tariffs/calculate
Калькулятор стоимости услуг (calculateTariffs)
Рассчитывает стоимость услуг Маркета для товаров с заданными параметрами. Порядок товаров в запросе и ответе сохраняется, чтобы определить,
для какого товара рассчитана стоимость услуги.
Обратите внимание: калькулятор осуществляет примерные расчеты. Финальная стоимость для каждого заказа зависит от предоставленных услуг.
В запросе можно указать либо параметр campaignId, либо sellingProgram. Совместное использование параметров приведет к ошибке.
|⚙️ Лимит: 100 запросов в минуту|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"offer" : {
"quantity" : 1,
"price" : 0.6027456183070403,
"length" : 0.14658129805029452,
"width" : 0.5962133916683182,
"weight" : 0.23021358869347652,
"categoryId" : 0,
"height" : 0.5637376656633328
},
"tariffs" : [ {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
}, {
"offer" : {
"quantity" : 1,
"price" : 0.6027456183070403,
"length" : 0.14658129805029452,
"width" : 0.5962133916683182,
"weight" : 0.23021358869347652,
"categoryId" : 0,
"height" : 0.5637376656633328
},
"tariffs" : [ {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Стоимость услуг.
CalculateTariffsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/price-quarantine/confirm
Удаление товара из карантина по цене в кабинете (confirmBusinessPrices)
Подтверждает основную цену на товары, которые попали в карантин, и удаляет их из карантина.
Основная цена задается в каталоге и действует во всех магазинах кабинета.
Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин
Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST businesses/{businessId}/price-quarantine.
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ 200 обозначает, что цены подтверждены.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/price-quarantine/confirm
Удаление товара из карантина по цене в магазине (confirmCampaignPrices)
Подтверждает в заданном магазине цену на товары, которые попали в карантин, и удаляет их из карантина.
Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин
Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST campaigns/{campaignId}/price-quarantine.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ 200 обозначает, что цены подтверждены.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/confirm
Подтверждение отгрузки (confirmShipment)
Подтверждает отгрузку товаров в сортировочный центр или пункт приема заказов.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/new
Создание нового чата с покупателем (createChat)
Создает новый чат с покупателем.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"chatId" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Все получилось: чат создан.
CreateChatResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers/delete
Удаление товаров из ассортимента магазина (deleteCampaignOffers)
Удаляет заданные товары из заданного магазина.
{% note warning "Запрос удаляет товары именно из конкретного магазина" %}
На продажи в других магазинах и на наличие товара в общем каталоге он не влияет.
{% endnote %}
Товар не получится удалить, если он хранится на складах Маркета.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notDeletedOfferIds" : [ null, null ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине.
DeleteCampaignOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/comments/delete
Удаление комментария к отзыву (deleteGoodsFeedbackComment)
Удаляет комментарий магазина.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/hidden-offers/delete
Возобновление показа товаров (deleteHiddenOffers)
Возобновляет показ скрытых вами товаров магазина на Маркете.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Показ товаров возобновлен.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/delete
Удаление товаров из каталога (deleteOffers)
Удаляет товары из каталога.
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notDeletedOfferIds" : [ null, null ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине.
DeleteOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/unarchive
Удаление товаров из архива (deleteOffersFromArchive)
Восстанавливает товары из архива.
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notUnarchivedOfferIds" : [ null, null ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если некоторые товары восстановить из архива не удалось, в ответе 200 будет их список.
Список успешно восстановленных товаров не возвращается.
DeleteOffersFromArchiveResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos/offers/delete
Удаление товаров из акции (deletePromoOffers)
Убирает товары из акции.
Изменения начинают действовать в течение 4–6 часов.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"rejectedOffers" : [ {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
}, {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Результат удаления товаров из акции.
DeletePromoOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/act
Получение акта приема-передачи (downloadShipmentAct)
{% note warning "Экспресс‑доставка" %}
Если ваш магазин подключен к экспресс‑доставке и вы отгружаете заказы курьерам Яндекс Go, подготавливать акт приема‑передачи не нужно.
{% endnote %}
Запрос формирует акт приема-передачи заказов, входящих в отгрузку, и возвращает акт в формате PDF. В акте содержатся собранные и готовые к отправке заказы.
При формировании акта Маркет автоматически находит и подставляет в шаблон следующие данные:
{% cut "Данные, из которых Маркет формирует акт" %}
| Данные в акте | Описание |
| --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Дата | Дата запроса. |
| Отправитель | Название вашего юридического лица, указанное в кабинете продавца на Маркете. |
| Исполнитель | Название юридического лица сортировочного центра или службы доставки. |
| № отправления в системе заказчика | Ваш идентификатор заказа, который вы указали в ответе на запрос POST order/accept от Маркета. |
| № отправления в системе исполнителя (субподрядчика) | Идентификатор заказа на Маркете, как в выходных данных запроса GET campaigns/{campaignId}/orders. |
| Объявленная ценность | Общая сумма заказа без учета стоимости доставки, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. |
| Вес | Масса брутто грузового места (суммарная масса упаковки и содержимого), как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. |
| Количество мест | Количество грузовых мест в заказе, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. |
{% endcut %}
Остальные поля нужно заполнить самостоятельно в распечатанном акте.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/pdfapplication/json
Responses
200
Акт приема-передачи для отгрузки в формате PDF.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/discrepancy-act
Получение акта расхождений (downloadShipmentDiscrepancyAct)
Возвращает акт расхождений для заданной отгрузки.
|⚙️ Лимит: 200 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.ms-excelapplication/json
Responses
200
Акт расхождений в формате XLSX.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/inbound-act
Получение фактического акта приема-передачи (downloadShipmentInboundAct)
Возвращает фактический акт приема-передачи для заданной отгрузки.
Такой акт становится доступен спустя несколько часов после завершения отгрузки. Он может понадобиться, если после отгрузки обнаружатся расхождения.
|⚙️ Лимит: 200 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/pdfapplication/json
Responses
200
Акт в формате PDF.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallet/labels
Ярлыки для доверительной приемки (FBS) (downloadShipmentPalletLabels)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Query parameters
format (optional)
Query Parameter —
Формат страниц PDF-файла с ярлыками:
A4 — по 16 ярлыков на странице.A8 — по одному ярлыку на странице.
default: null
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/pdfapplication/json
Responses
200
PDF‑файл с ярлыками на все упаковки в отгрузке.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/shipments/reception-transfer-act
Подтверждение ближайшей отгрузки и получение акта приема-передачи для нее (downloadShipmentReceptionTransferAct)
Запрос подтверждает ближайшую отгрузку и возвращает акт приема-передачи в формате PDF.
{% note warning "Экспресс‑доставка" %}
Если ваш магазин подключен к экспресс‑доставке и вы отгружаете заказы курьерам Яндекс Go, подготавливать акт приема‑передачи не нужно.
{% endnote %}
В акт входят собранные и готовые к отправке заказы, которые отгружаются в сортировочный центр или пункт приема или курьерам Маркета.
При формировании акта Маркет автоматически находит и подставляет в шаблон следующие данные:
{% cut "Данные, из которых Маркет формирует акт" %}
| Данные в акте | Описание |
| --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Отправитель | Название вашего юридического лица, указанное в кабинете продавца на Маркете. |
| Исполнитель | Название юридического лица сортировочного центра или службы доставки. |
| № отправления в системе заказчика | Ваш идентификатор заказа, который вы указали в ответе на запрос POST order/accept от Маркета. |
| № отправления в системе исполнителя (субподрядчика) | Идентификатор заказа на Маркете, как в выходных данных запроса GET campaigns/{campaignId}/orders. |
| Объявленная ценность | Общая сумма заказа без учета стоимости доставки, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. |
| Стоимость всех товаров в заказе | Стоимость всех заказанных товаров. |
| Вес | Масса брутто грузового места (суммарная масса упаковки и содержимого), как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. |
| Количество мест | Количество грузовых мест в заказе, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. |
{% endcut %}
Остальные поля нужно заполнить самостоятельно в распечатанном акте.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
warehouse_id (optional)
Query Parameter — Идентификатор склада. default: null format: int32
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/pdfapplication/json
Responses
200
Акт приема-передачи в формате PDF.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/transportation-waybill
Получение транспортной накладной (downloadShipmentTransportationWaybill)
Возвращает транспортную накладную для заданной отгрузки.
Транспортная накладная понадобится, если вы отгружаете товары непосредственно со своего склада. Подробно об этом способе отгрузки
|⚙️ Лимит: 200 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.ms-excelapplication/json
Responses
200
Транспортная накладная в формате XLSX.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/boost-consolidated/generate
Отчет по бусту продаж (generateBoostConsolidatedReport)
Запускает генерацию сводного отчета по бусту продаж за заданный период. Отчет содержит информацию по всем кампаниям, созданным и через API, и в кабинете.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/competitors-position/generate
Отчет «Конкурентная позиция» (generateCompetitorsPositionReport)
Запускает генерацию отчета «Конкурентная позиция» за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
{% note info "Значение -1 в отчете" %}
Если в CSV-файле в столбце POSITION стоит -1, в этот день не было заказов с товарами в указанной категории.
{% endnote %}
|⚙️ Лимит: 10 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/goods-feedback/generate
Отчет по отзывам о товарах (generateGoodsFeedbackReport)
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/goods-realization/generate
Отчет по реализации (generateGoodsRealizationReport)
Запускает генерацию отчета по реализации за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/documents/labels/generate
Готовые ярлыки‑наклейки на все коробки в нескольких заказах (generateMassOrderLabelsReport)
Запускает генерацию PDF-файла с ярлыками для переданных заказов. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке Маркета для продавцов.
Узнать статус генерации и получить ссылку на готовый файл можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 1000 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый файл.
Если при генерации не удалось найти часть заказов, в ответе на запрос получения готового файла вернется подстатус RESOURCE_NOT_FOUND.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label
Готовый ярлык‑наклейка для коробки в заказе (generateOrderLabel)
Формирует ярлык‑наклейку для коробки в заказе и возвращает ярлык в PDF‑файле.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор грузоместа. default: null format: int64
boxId (required)
Path Parameter — Идентификатор коробки. default: null format: int64
Query parameters
format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. default: null
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/pdfapplication/json
Responses
200
PDF‑файл с ярлыками для коробки. Файл содержит одну страницу с ярлыком.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/labels
Готовые ярлыки‑наклейки на все коробки в одном заказе (generateOrderLabels)
Возвращает PDF-файл с ярлыками, которые нужно наклеить на коробки перед отгрузкой. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке Маркета для продавцов.
На вход нужно передать идентификатор заказа и один необязательный параметр, который управляет версткой PDF-файла.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Query parameters
format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. default: null
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/pdfapplication/json
Responses
200
PDF‑файл с ярлыками на все коробки.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/prices/generate
Отчет «Цены на рынке» (generatePricesReport)
Запускает генерацию отчета «Цены на рынке».
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/shelf-statistics/generate
Отчет по полкам (generateShelfsStatisticsReport)
Запускает генерацию сводного отчета по полкам — рекламным блокам с баннером или видео и набором товаров. Подробнее о них читайте в Справке Маркета для продавцов.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/documents/shipment-list/generate
Получение листа сборки (generateShipmentListDocumentReport)
Запускает генерацию листа сборки для отгрузки.
Узнать статус генерации и получить ссылку на готовый документ можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый документ.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/shows-sales/generate
Отчет «Аналитика продаж» (generateShowsSalesReport)
Запускает генерацию отчета «Аналитика продаж» за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 10 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/stocks-on-warehouses/generate
Отчет по остаткам на складах (generateStocksOnWarehousesReport)
Запускает генерацию отчета по остаткам на складах. Отчет содержит данные:
- Для модели FBY — об остатках на складах Маркета.
- Для остальных моделей — об остатках на соответствующем складе магазина.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/united-marketplace-services/generate
Отчет по стоимости услуг (generateUnitedMarketplaceServicesReport)
Запускает генерацию отчета по стоимости услуг за заданный период. Что это за отчет
Тип отчета зависит от того, какие поля заполнены в запросе:
|Тип отчета |Какие поля нужны |
|-----------------------------|---------------------------------|
|По дате начисления услуги |dateFrom и dateTo |
|По дате формирования акта |year и month |
Заказать отчеты обоих типов одним запросом нельзя.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/united-netting/generate
Отчет по платежам (generateUnitedNettingReport)
Запускает генерацию отчета по платежам за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
Тип отчета зависит от того, какие поля заполнены в запросе:
|Тип отчета |Какие поля нужны |
|-------------------------|---------------------------------------|
|О платежах за период |dateFrom и dateTo |
|О платежном поручении |bankOrderId и bankOrderDateTime |
Заказать отчеты обоих типов одним запросом нельзя.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/united-orders/generate
Отчет по заказам (generateUnitedOrdersReport)
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offers/all
Все предложения магазина (getAllOffers)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет максимально быстро получить информацию обо всех предложениях магазина, размещенных на Маркете. Возвращает результат в виде сегментов нефиксированного размера.
В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Яндекс Маркета, с которой соотнесено предложение, а также аукционные ставки на него.
{% note info %}
Количество предложений считается по данным за последние семь дней (не включая сегодня).
Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
chunk (optional)
Query Parameter —
Номер сегмента с результатами.
Значение по умолчанию: 0.
{% note info %}
Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.
{% endnote %}
{% note alert %}
Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать chunk=0 и т. д.
{% endnote %}
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"offers" : [ {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
}, {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
} ]
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Предложения магазина.
GetAllOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/bids/info
Информация об установленных ставках (getBidsInfoForBusiness)
Возвращает значения ставок для заданных товаров.
{% note warning "" %}
В ответе возвращаются значения только тех ставок, которые вы установили через запрос PUT businesses/{businessId}/bids. Получить информацию по кампаниям, созданным в кабинете, не получится.
{% endnote %}
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"bids" : [ {
"sku" : "sku",
"bid" : 570
}, {
"sku" : "sku",
"bid" : 570
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Значения ставок для заданных товаров. В ответ попадают только товары, на которые установлены ставки.
GetBidsInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/bids/recommendations
Рекомендованные ставки для заданных товаров (getBidsRecommendations)
Возвращает рекомендованные ставки для заданных товаров — такие ставки обеспечивают вашим предложениям определенную долю показов, если цена не превышает рекомендованную.
Для одного товара может возвращаться одна рекомендованная ставка или несколько. Во втором случае разные ставки предназначены для достижения разной доли показов.
Если товар только добавлен в каталог, но пока не продается, рекомендованной ставки для него не будет.
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"recommendations" : [ {
"bidRecommendations" : [ {
"showPercent" : 8,
"bid" : 570
}, {
"showPercent" : 8,
"bid" : 570
} ],
"priceRecommendations" : [ {
"campaignId" : 6,
"price" : 1.1465812980502945
}, {
"campaignId" : 6,
"price" : 1.1465812980502945
} ],
"sku" : "sku",
"bid" : 570
}, {
"bidRecommendations" : [ {
"showPercent" : 8,
"bid" : 570
}, {
"showPercent" : 8,
"bid" : 570
} ],
"priceRecommendations" : [ {
"campaignId" : 6,
"price" : 1.1465812980502945
}, {
"campaignId" : 6,
"price" : 1.1465812980502945
} ],
"sku" : "sku",
"bid" : 570
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Рекомендованные ставки для заданных товаров.
GetBidsRecommendationsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/price-quarantine
Список товаров, находящихся в карантине по цене в кабинете (getBusinessQuarantineOffers)
Возвращает список товаров, которые находятся в карантине по основной цене. Основная цена задается в каталоге и действует во всех магазинах кабинета.
Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST businesses/{businessId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST businesses/{businessId}/offer-prices/updates.
{% note info "𝓠 Что такое карантин?" %}
𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее
{% endnote %}
В запросе можно использовать фильтры.
Результаты возвращаются постранично.
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
}, {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров в карантине.
GetQuarantineOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/settings
Настройки кабинета (getBusinessSettings)
Возвращает информацию о настройках кабинета, идентификатор которого указан в запросе.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Return type
Example data
Content-Type: application/json
{
"result" : {
"settings" : {
"currency" : "RUR",
"onlyDefaultPrice" : true
},
"info" : {
"name" : "name",
"id" : 0
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Настройки кабинета.
GetBusinessSettingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}
Информация о магазине (getCampaign)
Возвращает информацию о магазине.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"campaign" : {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о магазине.
GetCampaignResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/logins
Логины, связанные с магазином (getCampaignLogins)
Возвращает список логинов, у которых есть доступ к магазину.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"logins" : [ "logins", "logins" ]
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список логинов, связанных с магазином.
GetCampaignLoginsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers
Информация о товарах, которые размещены в заданном магазине (getCampaignOffers)
Возвращает список товаров, которые размещены в заданном магазине. Для каждого товара указываются параметры размещения.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"campaignPrice" : {
"vat" : 5,
"discountBase" : 5.962133916683182,
"currencyId" : "RUR",
"value" : 1.4658129805029452,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"available" : true,
"offerId" : "offerId",
"quantum" : {
"minQuantity" : 1,
"stepQuantity" : 60
},
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"status" : "PUBLISHED"
}, {
"campaignPrice" : {
"vat" : 5,
"discountBase" : 5.962133916683182,
"currencyId" : "RUR",
"value" : 1.4658129805029452,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"available" : true,
"offerId" : "offerId",
"quantum" : {
"minQuantity" : 1,
"stepQuantity" : 60
},
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"status" : "PUBLISHED"
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров, размещенных в заданном магазине.
GetCampaignOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/price-quarantine
Список товаров, находящихся в карантине по цене в магазине (getCampaignQuarantineOffers)
Возвращает список товаров, которые находятся в карантине по цене, установленной в заданном магазине.
Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST campaigns/{campaignId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST campaigns/{campaignId}/offer-prices/updates.
{% note info "𝓠 Что такое карантин?" %}
𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее
{% endnote %}
В запросе можно использовать фильтры.
Результаты возвращаются постранично.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
}, {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров в карантине.
GetQuarantineOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/region
Регион магазина (getCampaignRegion)
{% note warning "" %}
Этот метод устарел. Вместо него используйте GET campaigns/{campaignId}/settings.
{% endnote %}
Возвращает регион, в котором находится магазин.
|⚙️ Лимит: 5 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Возвращает регион, в котором находится магазин.
|⚙️ Лимит: 1000 запросов в час|
|-|
GetCampaignRegionResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/settings
Настройки магазина (getCampaignSettings)
Возвращает информацию о настройках магазина, идентификатор которого указан в запросе.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"settings" : {
"showInPremium" : true,
"showInContext" : true,
"localRegion" : {
"delivery" : {
"schedule" : {
"customWorkingDays" : [ "23-09-2022", "23-09-2022" ],
"period" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022"
},
"customHolidays" : [ "23-09-2022", "23-09-2022" ],
"weeklyHolidays" : [ 1, 1 ],
"availableOnHolidays" : true,
"totalHolidays" : [ "23-09-2022", "23-09-2022" ]
}
},
"name" : "name",
"id" : 6,
"type" : "OTHER",
"deliveryOptionsSource" : "WEB"
},
"countryRegion" : 0,
"shopName" : "shopName",
"useOpenStat" : true
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Настройки магазина.
GetCampaignSettingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Список магазинов пользователя (getCampaigns)
Возвращает список магазинов, к которым имеет доступ пользователь — владелец авторизационного токена, использованного в запросе. Для агентских пользователей список состоит из подагентских магазинов.
|⚙️ Лимит: 1000 запросов в час|
|-|
Query parameters
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"campaigns" : [ {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
}, {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
} ],
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Магазины пользователя.
GetCampaignsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/by_login/{login}
Магазины, доступные логину (getCampaignsByLogin)
Возвращает список магазинов, к которым у пользователя с указанным логином есть доступ.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
login (required)
Path Parameter — Логин пользователя. default: null
Query parameters
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"campaigns" : [ {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
}, {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
} ],
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о магазинах.
GetCampaignsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /categories/max-sale-quantum
Лимит на установку кванта продажи и минимального количества товаров в заказе (getCategoriesMaxSaleQuantum)
Возвращает лимит на установку кванта и минимального количества товаров в заказе, которые вы можете задать для товаров указанных категорий.
Если вы передадите значение кванта или минимального количества товаров выше установленного Маркетом ограничения, товар будет скрыт с витрины.
Подробнее о том, как продавать товары по несколько штук, читайте в Справке Маркета для продавцов.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"results" : [ {
"maxSaleQuantum" : 6,
"name" : "name",
"id" : 0
}, {
"maxSaleQuantum" : 6,
"name" : "name",
"id" : 0
} ],
"errors" : [ {
"type" : "UNKNOWN_CATEGORY",
"categoryId" : 1
}, {
"type" : "UNKNOWN_CATEGORY",
"categoryId" : 1
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Лимит на установку кванта и минимального количества товаров.
GetCategoriesMaxSaleQuantumResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Дерево категорий (getCategoriesTree)
Возвращает дерево категорий Маркета.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Категории Маркета.
GetCategoriesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /category/{categoryId}/parameters
Списки характеристик товаров по категориям (getCategoryContentParameters)
Возвращает список характеристик с допустимыми значениями для заданной категории.
|⚙️ Лимит: 50 категорий в минуту |
|-|
Path parameters
categoryId (required)
Path Parameter —
Идентификатор категории на Маркете.
Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом POST categories/tree.
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"parameters" : [ {
"values" : [ {
"description" : "description",
"id" : 5,
"value" : "value"
}, {
"description" : "description",
"id" : 5,
"value" : "value"
} ],
"recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
"description" : "description",
"type" : "TEXT",
"constraints" : {
"minValue" : 2.3021358869347655,
"maxValue" : 7.061401241503109,
"maxLength" : 9
},
"required" : true,
"multivalue" : true,
"unit" : {
"defaultUnitId" : 1,
"units" : [ {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
}, {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
} ]
},
"valueRestrictions" : [ {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
}, {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
} ],
"distinctive" : true,
"name" : "name",
"id" : 6,
"filtering" : true,
"allowCustomValues" : true
}, {
"values" : [ {
"description" : "description",
"id" : 5,
"value" : "value"
}, {
"description" : "description",
"id" : 5,
"value" : "value"
} ],
"recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
"description" : "description",
"type" : "TEXT",
"constraints" : {
"minValue" : 2.3021358869347655,
"maxValue" : 7.061401241503109,
"maxLength" : 9
},
"required" : true,
"multivalue" : true,
"unit" : {
"defaultUnitId" : 1,
"units" : [ {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
}, {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
} ]
},
"valueRestrictions" : [ {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
}, {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
} ],
"distinctive" : true,
"name" : "name",
"id" : 6,
"filtering" : true,
"allowCustomValues" : true
} ],
"categoryId" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список характеристик товаров из заданной категории.
GetCategoryContentParametersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/history
Получение истории сообщений в чате (getChatHistory)
Возвращает историю сообщений в чате с покупателем.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"orderId" : 0,
"messages" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"sender" : "PARTNER",
"payload" : [ {
"size" : 1,
"name" : "name",
"url" : "url"
}, {
"size" : 1,
"name" : "name",
"url" : "url"
} ],
"messageId" : 6,
"message" : "message"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"sender" : "PARTNER",
"payload" : [ {
"size" : 1,
"name" : "name",
"url" : "url"
}, {
"size" : 1,
"name" : "name",
"url" : "url"
} ],
"messageId" : 6,
"message" : "message"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
История сообщений успешно получена.
GetChatHistoryResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats
Получение доступных чатов (getChats)
Возвращает ваши чаты с покупателями.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"chats" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"chatId" : 0,
"orderId" : 6,
"type" : "CHAT",
"status" : "NEW",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"chatId" : 0,
"orderId" : 6,
"type" : "CHAT",
"status" : "NEW",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список чатов.
GetChatsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /delivery/services
Справочник служб доставки (getDeliveryServices)
Возвращает справочник служб доставки: идентификаторы и наименования.
|⚙️ Лимит: 5 000 запросов в час|
|-|
Return type
Example data
Content-Type: application/json
{
"result" : {
"deliveryService" : [ {
"name" : "name",
"id" : 0
}, {
"name" : "name",
"id" : 0
} ]
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о службах доставки.
GetDeliveryServicesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feeds/{feedId}
Информация о прайс-листе (getFeed)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает информацию о прайс-листе, размещенном на Маркете для заданного магазина. Также ресурс возвращает результаты автоматических проверок прайс-листа.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"feed" : {
"password" : "password",
"download" : {
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 5
}
},
"uploadDate" : "2000-01-23T04:56:07.000+00:00",
"publication" : {
"priceAndStockUpdate" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
},
"full" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
}
},
"name" : "name",
"id" : 0,
"placement" : {
"totalOffersCount" : 5
},
"login" : "login",
"url" : "url",
"content" : {
"rejectedOffersCount" : 6,
"error" : {
"type" : "PARSE_ERROR"
},
"status" : "ERROR",
"totalOffersCount" : 1
}
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о прайс-листе.
GetFeedResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feeds/{feedId}/index-logs
Отчет по индексации прайс-листа (getFeedIndexLogs)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает отчет по индексации прайс-листа для заданного магазина. Отчет позволяет получить статистику загрузки прайс-листа и результаты его автоматических проверок.
Данные в отчете возвращаются в порядке убывания значений параметра generationId.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Query parameters
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
published_time_from (optional)
Query Parameter —
Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
Значение по умолчанию: последние восемь дней со времени отправки запроса.
default: null format: date-time
published_time_to (optional)
Query Parameter —
Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-31T00:42:42+03:00.
Значение по умолчанию: дата и время отправки запроса.
{% note info %}
Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра published_time_to. Значение параметра не должно быть датой из будущего.
{% endnote %}
default: null format: date-time
status (optional)
Query Parameter —
Статус индексации и проверки прайс-листа на соответствие техническим требованиям.
Возможные значения:
ERROR — произошли ошибки.OK — обработан без ошибок.WARNING — наблюдались некритичные проблемы.
default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"feed" : {
"id" : 0
},
"total" : 2,
"indexLogRecords" : [ {
"offers" : {
"rejectedCount" : 5,
"totalCount" : 5
},
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"generationId" : 6,
"indexType" : "DIFF",
"publishedTime" : "2000-01-23T04:56:07.000+00:00",
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 1
},
"downloadTime" : "2000-01-23T04:56:07.000+00:00",
"status" : "ERROR"
}, {
"offers" : {
"rejectedCount" : 5,
"totalCount" : 5
},
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"generationId" : 6,
"indexType" : "DIFF",
"publishedTime" : "2000-01-23T04:56:07.000+00:00",
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 1
},
"downloadTime" : "2000-01-23T04:56:07.000+00:00",
"status" : "ERROR"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Отчет по индексации прайс-листа.
GetFeedIndexLogsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feedback/updates
Новые и обновленные отзывы о магазине (getFeedbackAndCommentUpdates)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает новые и обновленные отзывы о магазине на Маркете.
Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Выходные данные содержат идентификатор следующей страницы.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
from_date (optional)
Query Parameter —
Начальная дата обновления отзывов.
Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.
Формат даты: ГГГГ-ММ-ДД.
default: null format: date
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
},
"feedbackList" : [ {
"comments" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"shop" : {
"name" : "name"
},
"author" : {
"name" : "name",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}
},
"verified" : true,
"recommend" : true,
"grades" : {
"average" : 5.962133916683182,
"agreeCount" : 5,
"rejectCount" : 2,
"factors" : [ {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
}, {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
} ]
},
"pro" : "pro",
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"text" : "text",
"state" : "LAST",
"contra" : "contra",
"resolved" : true,
"order" : {
"delivery" : "DELIVERY",
"shopOrderId" : "shopOrderId"
}
}, {
"comments" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"shop" : {
"name" : "name"
},
"author" : {
"name" : "name",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}
},
"verified" : true,
"recommend" : true,
"grades" : {
"average" : 5.962133916683182,
"agreeCount" : 5,
"rejectCount" : 2,
"factors" : [ {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
}, {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
} ]
},
"pro" : "pro",
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"text" : "text",
"state" : "LAST",
"contra" : "contra",
"resolved" : true,
"order" : {
"delivery" : "DELIVERY",
"shopOrderId" : "shopOrderId"
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список отзывов для магазина.
GetFeedbackListResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feeds
Список прайс-листов магазина (getFeeds)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает список прайс-листов, размещенных на Маркете для магазина. Также ресурс возвращает результаты автоматических проверок прайс-листов.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"feeds" : [ {
"password" : "password",
"download" : {
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 5
}
},
"uploadDate" : "2000-01-23T04:56:07.000+00:00",
"publication" : {
"priceAndStockUpdate" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
},
"full" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
}
},
"name" : "name",
"id" : 0,
"placement" : {
"totalOffersCount" : 5
},
"login" : "login",
"url" : "url",
"content" : {
"rejectedOffersCount" : 6,
"error" : {
"type" : "PARSE_ERROR"
},
"status" : "ERROR",
"totalOffersCount" : 1
}
}, {
"password" : "password",
"download" : {
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 5
}
},
"uploadDate" : "2000-01-23T04:56:07.000+00:00",
"publication" : {
"priceAndStockUpdate" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
},
"full" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
}
},
"name" : "name",
"id" : 0,
"placement" : {
"totalOffersCount" : 5
},
"login" : "login",
"url" : "url",
"content" : {
"rejectedOffersCount" : 6,
"error" : {
"type" : "PARSE_ERROR"
},
"status" : "ERROR",
"totalOffersCount" : 1
}
} ]
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список прайс-листов.
GetFeedsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/comments
Получение комментариев к отзыву (getGoodsFeedbackComments)
Возвращает комментарии к отзыву.
Результаты возвращаются постранично, одна страница содержит не более 20 комментариев.
Комментарии расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"comments" : [ {
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 0,
"text" : "text",
"canModify" : true,
"parentId" : 6,
"status" : "PUBLISHED"
}, {
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 0,
"text" : "text",
"canModify" : true,
"parentId" : 6,
"status" : "PUBLISHED"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Дерево комментариев к отзыву.
GetGoodsFeedbackCommentsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback
Получение отзывов о товарах продавца (getGoodsFeedbacks)
Возвращает все отзывы о товарах продавца по указанным фильтрам.
Результаты возвращаются постранично, одна страница содержит не более 20 отзывов.
Отзывы расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"feedbacks" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"needReaction" : true,
"identifiers" : {
"orderId" : 6,
"modelId" : 1
},
"author" : "author",
"feedbackId" : 0,
"description" : {
"advantages" : "advantages",
"disadvantages" : "disadvantages",
"comment" : "comment"
},
"media" : {
"videos" : [ "videos", "videos" ],
"photos" : [ "photos", "photos" ]
},
"statistics" : {
"commentsCount" : 5,
"rating" : 3,
"paidAmount" : 2,
"recommended" : true
}
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"needReaction" : true,
"identifiers" : {
"orderId" : 6,
"modelId" : 1
},
"author" : "author",
"feedbackId" : 0,
"description" : {
"advantages" : "advantages",
"disadvantages" : "disadvantages",
"comment" : "comment"
},
"media" : {
"videos" : [ "videos", "videos" ],
"photos" : [ "photos", "photos" ]
},
"statistics" : {
"commentsCount" : 5,
"rating" : 3,
"paidAmount" : 2,
"recommended" : true
}
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список отзывов.
GetGoodsFeedbackResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/stats/skus
Отчет по товарам (getGoodsStats)
Возвращает подробный отчет по товарам, которые вы разместили на Маркете. С помощью отчета вы можете узнать, например, об остатках на складе, об условиях хранения ваших товаров и т. д.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"shopSkus" : [ {
"shopSku" : "shopSku",
"marketSku" : 0,
"price" : 6.027456183070403,
"name" : "name",
"warehouses" : [ {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
}, {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
} ],
"weightDimensions" : {
"length" : 5.962133916683182,
"width" : 5.637376656633329,
"weight" : 7.061401241503109,
"height" : 2.3021358869347655
},
"categoryName" : "categoryName",
"categoryId" : 1,
"pictures" : [ "pictures", "pictures" ],
"tariffs" : [ {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
}, {
"shopSku" : "shopSku",
"marketSku" : 0,
"price" : 6.027456183070403,
"name" : "name",
"warehouses" : [ {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
}, {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
} ],
"weightDimensions" : {
"length" : 5.962133916683182,
"width" : 5.637376656633329,
"weight" : 7.061401241503109,
"height" : 2.3021358869347655
},
"categoryName" : "categoryName",
"categoryId" : 1,
"pictures" : [ "pictures", "pictures" ],
"tariffs" : [ {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Отчет по товарам.
GetGoodsStatsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/hidden-offers
Информация о скрытых вами товарах (getHiddenOffers)
Возвращает список скрытых вами товаров для заданного магазина.
В списке будут товары, скрытые любым способом — по API, с помощью YML-фида, в кабинете и так далее.
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
offer_id (optional)
Query Parameter — Идентификатор скрытого предложения. default: null
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
offset (optional)
Query Parameter —
Позиция в списке, начиная с которой возвращаются результаты ответа.
Используется вместе с параметром limit.
Если задан offset, параметры page_number и page_size игнорируются.
offset игнорируется, если задан page_token.
default: null format: int32
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"hiddenOffers" : [ {
"offerId" : "offerId"
}, {
"offerId" : "offerId"
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о скрытых вами товарах.
GetHiddenOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-cards
Получение информации о заполненности карточек магазина (getOfferCardsContentStatus)
Возвращает сведения о состоянии контента для заданных товаров:
- создана ли карточка товара и в каком она статусе;
- заполненность карточки в процентах;
- переданные характеристики товаров;
- есть ли ошибки или предупреждения, связанные с контентом;
- рекомендации по заполнению карточки.
|⚙️ Лимит: 600 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offerCards" : [ {
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"offerId" : "offerId",
"contentRating" : 0,
"recommendations" : [ {
"type" : "HAS_VIDEO",
"percent" : 60
}, {
"type" : "HAS_VIDEO",
"percent" : 60
} ],
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"parameterValues" : [ {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
}, {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
} ]
}, {
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"offerId" : "offerId",
"contentRating" : 0,
"recommendations" : [ {
"type" : "HAS_VIDEO",
"percent" : 60
}, {
"type" : "HAS_VIDEO",
"percent" : 60
} ],
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"parameterValues" : [ {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
}, {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
} ]
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о карточках указанных товаров.
GetOfferCardsContentStatusResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offer-mapping-entries
Список товаров в каталоге (getOfferMappingEntries)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings.
{% endnote %}
Для каждого товара, который вы размещаете на Маркете, возвращается информация о карточках Маркета, к которым привязан этот товар:
- Идентификатор текущей карточки (marketSku), карточки, которая проходит модерацию и последней отклоненной карточки.
- Описание товара, которое указано на карточке Маркета. Например, размер упаковки и вес товара.
Результаты возвращаются постранично. Выходные данные содержат идентификатор следующей страницы.
{% note info %}
Количество товаров в каталоге магазина считается по данным за последние семь дней (не включая сегодня).
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
offer_id (optional)
Query Parameter — Идентификатор товара в каталоге. default: null
shop_sku (optional)
Query Parameter —
Ваш SKU товара.
Параметр может быть указан несколько раз, например:
...shop_sku=123&shop_sku=129&shop_sku=141...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
mapping_kind (optional)
Query Parameter — Тип маппинга. default: null
status (optional)
Query Parameter —
Фильтрация по статусу публикации товара:
READY — товар прошел модерацию.IN_WORK — товар проходит модерацию.NEED_CONTENT — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.NEED_INFO — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.REJECTED — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.SUSPENDED — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.OTHER — товар не прошел модерацию по другой причине.
Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
availability (optional)
Query Parameter —
Фильтрация по планам поставок товара:
ACTIVE — поставки будут.INACTIVE — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.DELISTED — архив: товар закончился на складе, и его поставок больше не будет.
Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
category_id (optional)
Query Parameter —
Фильтрация по идентификатору категории на Маркете.
Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом POST categories/tree.
Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
vendor (optional)
Query Parameter —
Фильтрация по бренду товара.
Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.
Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе Кодирование URL русскоязычной Википедии.
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offerMappingEntries" : [ {
"offer" : {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
},
"mapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"awaitingModerationMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"rejectedMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
}
}, {
"offer" : {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
},
"mapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"awaitingModerationMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"rejectedMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
}
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о товарах в каталоге.
GetOfferMappingEntriesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings
Информация о товарах в каталоге (getOfferMappings)
Возвращает список товаров в каталоге, их категории на Маркете и характеристики каждого товара.
Можно использовать тремя способами:
- задать список интересующих SKU;
- задать фильтр — в этом случае результаты возвращаются постранично;
- не передавать тело запроса, чтобы получить список всех товаров в каталоге.
|⚙️ Лимит: 600 запросов в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
},
"offerMappings" : [ {
"offer" : {
"downloadable" : true,
"sellingPrograms" : [ {
"sellingProgram" : "FBY",
"status" : "FINE"
}, {
"sellingProgram" : "FBY",
"status" : "FINE"
} ],
"marketCategoryId" : 0,
"manufacturerCountries" : [ "Россия", "Россия" ],
"description" : "description",
"videos" : [ "videos", "videos", "videos", "videos", "videos" ],
"purchasePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"type" : "DEFAULT",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"archived" : true,
"campaigns" : [ {
"campaignId" : 9,
"status" : "PUBLISHED"
}, {
"campaignId" : 9,
"status" : "PUBLISHED"
} ],
"vendor" : "LEVENHUK",
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"barcodes" : [ "46012300000000", "46012300000000" ],
"params" : [ {
"name" : "Wi-Fi",
"value" : "есть"
}, {
"name" : "Wi-Fi",
"value" : "есть"
} ],
"tags" : [ "до 500 рублей", "до 500 рублей" ],
"condition" : {
"reason" : "reason",
"type" : "PREOWNED",
"quality" : "PERFECT"
},
"certificates" : [ "certificates", "certificates" ],
"boxCount" : 1,
"additionalExpenses" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"customsCommodityCode" : "8517610008",
"adult" : true,
"age" : {
"ageUnit" : "YEAR",
"value" : 0.5962133916683182
},
"manuals" : [ {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
} ]
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
}, {
"offer" : {
"downloadable" : true,
"sellingPrograms" : [ {
"sellingProgram" : "FBY",
"status" : "FINE"
}, {
"sellingProgram" : "FBY",
"status" : "FINE"
} ],
"marketCategoryId" : 0,
"manufacturerCountries" : [ "Россия", "Россия" ],
"description" : "description",
"videos" : [ "videos", "videos", "videos", "videos", "videos" ],
"purchasePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"type" : "DEFAULT",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"archived" : true,
"campaigns" : [ {
"campaignId" : 9,
"status" : "PUBLISHED"
}, {
"campaignId" : 9,
"status" : "PUBLISHED"
} ],
"vendor" : "LEVENHUK",
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"barcodes" : [ "46012300000000", "46012300000000" ],
"params" : [ {
"name" : "Wi-Fi",
"value" : "есть"
}, {
"name" : "Wi-Fi",
"value" : "есть"
} ],
"tags" : [ "до 500 рублей", "до 500 рублей" ],
"condition" : {
"reason" : "reason",
"type" : "PREOWNED",
"quality" : "PERFECT"
},
"certificates" : [ "certificates", "certificates" ],
"boxCount" : 1,
"additionalExpenses" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"customsCommodityCode" : "8517610008",
"adult" : true,
"age" : {
"ageUnit" : "YEAR",
"value" : 0.5962133916683182
},
"manuals" : [ {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
} ]
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о товарах в каталоге.
GetOfferMappingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offers/recommendations
Рекомендации Маркета, касающиеся цен (getOfferRecommendations)
Метод возвращает рекомендации нескольких типов.
1. Порог для привлекательной цены. Он нужен для участия в софинансировании скидок.
Показывает, какие цены для участия нужно установить, чтобы получить максимальные шансы на срабатывание скидок, софинансируемых Маркетом. Как это устроено
2. Оценка привлекательности цен на витрине.
Привлекательность влияет на вероятность срабатывания скидок за счет Маркета. Как это устроено
В запросе можно использовать фильтры.
Результаты возвращаются постранично.
|⚙️ Лимит: 100 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
},
"offerRecommendations" : [ {
"offer" : {
"shows" : 0,
"price" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitiveness" : "OPTIMAL",
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}
},
"recommendation" : {
"recommendedCofinancePrice" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitivenessThresholds" : {
"optimalPrice" : {
"value" : 0.9301444243932576
},
"averagePrice" : {
"value" : 0.9301444243932576
}
}
}
}, {
"offer" : {
"shows" : 0,
"price" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitiveness" : "OPTIMAL",
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}
},
"recommendation" : {
"recommendedCofinancePrice" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitivenessThresholds" : {
"optimalPrice" : {
"value" : 0.9301444243932576
},
"averagePrice" : {
"value" : 0.9301444243932576
}
}
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров с рекомендациями.
GetOfferRecommendationsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offers
Предложения магазина (getOffers)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет фильтровать информацию о предложениях магазина, размещенных на Маркете, и искать предложения по заданному поисковому запросу.
Поиск предложений, размещенных на Маркете, работает по поисковому запросу аналогично поиску Маркета. Результаты возвращаются с использованием пейджера.
В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Маркета, с которой соотнесено предложение, и аукционные ставки на него.
{% note info %}
Из-за особенностей поиска Маркета иногда на последних страницах пейджера фактическое количество результатов оказывается меньше количества, указанного ранее на предыдущих страницах.
В связи с этим настоятельно рекомендуется анализировать содержимое параметра pager для каждой полученной страницы.
{% endnote %}
{% note info %}
Количество предложений считается по данным за последние семь дней (не включая сегодня).
Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
query (optional)
Query Parameter —
Поисковый запрос.
Поддерживается язык запросов.
Значение по умолчанию: все предложения магазина, размещенные на Маркете.
default: null
feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
shopCategoryId (optional)
Query Parameter —
Идентификатор категории предложения, указанный магазином в прайс-листе.
Параметр выводится только для предложений, у которых указана категория в прайс-листе.
Параметр доступен начиная с версии 2.0 партнерского API.
default: null
currency (optional)
Query Parameter —
Валюта, в которой указана цена предложения.
Возможные значения:
default: null
matched (optional)
Query Parameter —
Фильтр по признаку соотнесения предложения и карточки модели.
Возможные значения:
-
0 / FALSE / NO — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.
-
1 / TRUE / YES — поиск выполняется среди предложений, соотнесенных с карточками моделей).
default: null
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"offers" : [ {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
}, {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
} ],
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Предложения магазина.
GetOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}
Информация об одном заказе (getOrder)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"order" : {
"delivery" : {
"dispatchType" : "UNKNOWN",
"address" : {
"country" : "country",
"city" : "city",
"postcode" : "postcode",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"house" : "house",
"subway" : "subway",
"phone" : "phone",
"street" : "street",
"district" : "district",
"recipient" : "recipient",
"entryphone" : "entryphone",
"block" : "block",
"entrance" : "entrance",
"floor" : "floor",
"apartment" : "apartment"
},
"liftType" : "NOT_NEEDED",
"deliveryServiceId" : 6,
"estimated" : true,
"dates" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022",
"fromTime" : "fromTime",
"toTime" : "toTime",
"realDeliveryDate" : "23-09-2022"
},
"type" : "DELIVERY",
"serviceName" : "serviceName",
"shipments" : [ {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
}, {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
} ],
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ],
"courier" : {
"vehicleDescription" : "vehicleDescription",
"phone" : "phone",
"phoneExtension" : "phoneExtension",
"fullName" : "fullName",
"vehicleNumber" : "vehicleNumber"
},
"price" : 5.025004791520295,
"outletStorageLimitDate" : "23-09-2022",
"eacType" : "MERCHANT_TO_COURIER",
"liftPrice" : 8.762042012749001,
"eacCode" : "eacCode",
"id" : "id",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"deliveryPartnerType" : "SHOP",
"outletCode" : "outletCode"
},
"notes" : "notes",
"substatus" : "RESERVATION_EXPIRED",
"deliveryTotal" : 1.4658129805029452,
"buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
"creationDate" : "23-09-2022 09:12:41",
"buyerItemsTotal" : 5.962133916683182,
"paymentType" : "PREPAID",
"buyer" : {
"lastName" : "lastName",
"firstName" : "firstName",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"expiryDate" : "23-09-2022 09:12:41",
"buyerTotalBeforeDiscount" : 7.061401241503109,
"itemsTotal" : 6.027456183070403,
"buyerTotal" : 5.637376656633329,
"subsidies" : [ {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
} ],
"paymentMethod" : "CASH_ON_DELIVERY",
"currency" : "RUR",
"fake" : true,
"id" : 0,
"taxSystem" : "OSN",
"cancelRequested" : true,
"items" : [ {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
}, {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
} ],
"status" : "PLACING",
"updatedAt" : "23-09-2022 09:12:41"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о заказе.
GetOrderResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/{orderId}/business-buyer
Информация о покупателе — юридическом лице (getOrderBusinessBuyerInfo)
Возвращает информацию о покупателе по идентификатору заказа.
{% note info "" %}
Чтобы получить информацию о покупателе, который является физическим лицом, воспользуйтесь запросом GET campaigns/{campaignId}/orders/{orderId}/buyer.
{% endnote %}
Получить данные можно, только если заказ находится в статусе PROCESSING, DELIVERY, PICKUP или DELIVERED.
Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.
|⚙️ Лимит: 3 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"organizationName" : "organizationName",
"organizationJurAddress" : "organizationJurAddress",
"inn" : "inn",
"kpp" : "kpp"
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о покупателе.
GetBusinessBuyerInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/{orderId}/documents
Информация о документах (getOrderBusinessDocumentsInfo)
Возвращает информацию о документах по идентификатору заказа.
Получить данные можно после того, как заказ перейдет в статус DELIVERED.
Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.
|⚙️ Лимит: 3 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"sf" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"torgTwelve" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"upd" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"ukd" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"ksf" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о документах.
GetBusinessDocumentsInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/labels/data
Данные для самостоятельного изготовления ярлыков (getOrderLabelsData)
Возвращает информацию на ярлыках, которые клеятся на коробки в заказе.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"parcelBoxLabels" : [ {
"supplierName" : "supplierName",
"deliveryServiceId" : "deliveryServiceId",
"orderId" : 1,
"fulfilmentId" : "fulfilmentId",
"orderNum" : "orderNum",
"weight" : "weight",
"url" : "url",
"deliveryServiceName" : "deliveryServiceName",
"deliveryAddress" : "deliveryAddress",
"recipientName" : "recipientName",
"place" : "place",
"shipmentDate" : "shipmentDate",
"boxId" : 5
}, {
"supplierName" : "supplierName",
"deliveryServiceId" : "deliveryServiceId",
"orderId" : 1,
"fulfilmentId" : "fulfilmentId",
"orderNum" : "orderNum",
"weight" : "weight",
"url" : "url",
"deliveryServiceName" : "deliveryServiceName",
"deliveryAddress" : "deliveryAddress",
"recipientName" : "recipientName",
"place" : "place",
"shipmentDate" : "shipmentDate",
"boxId" : 5
} ],
"orderId" : 0,
"placesNumber" : 6,
"url" : "url"
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация для печати ярлыков.
GetOrderLabelsDataResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders
Информация о нескольких заказах (getOrders)
Возвращает информацию о заказах. Запрос можно использовать, чтобы узнать, нет ли новых заказов.
Доступна фильтрация по нескольким характеристикам заказов:
-
дате оформления;
-
статусу;
-
идентификаторам заказов;
-
этапу обработки или причине отмены;
-
типу (настоящий или тестовый);
-
дате отгрузки в службу доставки;
-
дате и времени обновления заказа.
Информация о заказах, доставленных или отмененных больше 30 дней назад, не возвращается. Ее можно получить с помощью запроса информации об отдельном заказе GET campaigns/{campaignId}/orders/{orderId} (если у вас есть идентификатор заказа) или запроса отчета по заказам POST campaigns/{campaignId}/stats/orders.
Максимальный диапазон дат за один запрос к ресурсу — 30 дней. Максимальное количество заказов в выходных данных запроса — 50.
Результаты возвращаются постранично. Для навигации по страницам используйте параметры page_token и limit.
Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса GET campaigns/{campaignId}/orders/{orderId}/buyer.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
orderIds (optional)
Query Parameter — Фильтрация заказов по идентификаторам.
⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. default: null format: int64
status (optional)
Query Parameter —
Статус заказа:
-
CANCELLED — заказ отменен.
-
DELIVERED — заказ получен покупателем.
-
DELIVERY — заказ передан в службу доставки.
-
PICKUP — заказ доставлен в пункт самовывоза.
-
PROCESSING — заказ находится в обработке.
-
UNPAID — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении).
Также могут возвращаться другие значения. Обрабатывать их не требуется.
default: null
substatus (optional)
Query Parameter —
Этап обработки заказа (если он имеет статус PROCESSING) или причина отмены заказа (если он имеет статус CANCELLED).
Возможные значения для заказа в статусе PROCESSING:
STARTED — заказ подтвержден, его можно начать обрабатывать.READY_TO_SHIP — заказ собран и готов к отправке.SHIPPED — заказ передан службе доставки.
Возможные значения для заказа в статусе CANCELLED:
-
DELIVERY_SERVICE_UNDELIVERED — служба доставки не смогла доставить заказ.
-
PROCESSING_EXPIRED — значение более не используется.
-
REPLACING_ORDER — покупатель решил заменить товар другим по собственной инициативе.
-
RESERVATION_EXPIRED — покупатель не завершил оформление зарезервированного заказа в течение 10 минут.
-
RESERVATION_FAILED — Маркет не может продолжить дальнейшую обработку заказа.
-
SHOP_FAILED — магазин не может выполнить заказ.
-
USER_CHANGED_MIND — покупатель отменил заказ по личным причинам.
-
USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут.
-
USER_REFUSED_DELIVERY — покупателя не устроили условия доставки.
-
USER_REFUSED_PRODUCT — покупателю не подошел товар.
-
USER_REFUSED_QUALITY — покупателя не устроило качество товара.
-
USER_UNREACHABLE — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:
- не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
- перерыв между первым и третьим звонком не менее 90 минут;
- соединение не короче 5 секунд.
Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.
-
USER_WANTS_TO_CHANGE_DELIVERY_DATE — покупатель хочет получить заказ в другой день.
-
CANCELLED_COURIER_NOT_FOUND — не удалось найти курьера.
Также могут возвращаться другие значения. Обрабатывать их не требуется.
default: null
fromDate (optional)
Query Parameter —
Начальная дата для фильтрации заказов по дате оформления.
Формат даты: ДД-ММ-ГГГГ.
Между начальной и конечной датой (параметр toDate) должно быть не больше 30 дней.
Значение по умолчанию: 30 дней назад от текущей даты.
default: null format: date
toDate (optional)
Query Parameter —
Конечная дата для фильтрации заказов по дате оформления.
Показываются заказы, созданные до 00:00 указанного дня.
Формат даты: ДД-ММ-ГГГГ.
Между начальной (параметр fromDate) и конечной датой должно быть не больше 30 дней.
Значение по умолчанию: текущая дата.
default: null format: date
supplierShipmentDateFrom (optional)
Query Parameter —
Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).
Формат даты: ДД-ММ-ГГГГ.
Между начальной и конечной датой (параметр supplierShipmentDateTo) должно быть не больше 30 дней.
Начальная дата включается в интервал для фильтрации.
default: null format: date
supplierShipmentDateTo (optional)
Query Parameter —
Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).
Формат даты: ДД-ММ-ГГГГ.
Между начальной (параметр supplierShipmentDateFrom) и конечной датой должно быть не больше 30 дней.
Конечная дата не включается в интервал для фильтрации.
default: null format: date
updatedAtFrom (optional)
Query Parameter —
Начальная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
Между начальной и конечной датой (параметр updatedAtTo) должно быть не больше 30 дней.
Начальная дата включается в интервал для фильтрации.
default: null format: date-time
updatedAtTo (optional)
Query Parameter —
Конечная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
Между начальной (параметр updatedAtFrom) и конечной датой должно быть не больше 30 дней.
Конечная дата не включается в интервал для фильтрации.
default: null format: date-time
dispatchType (optional)
Query Parameter — Способ отгрузки default: null
fake (optional)
Query Parameter —
Фильтрация заказов по типам:
default: false
hasCis (optional)
Query Parameter —
Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации в системе «Честный ЗНАК»:
Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.
default: false
onlyWaitingForCancellationApprove (optional)
Query Parameter —
Только для модели DBS
Фильтрация заказов по наличию запросов покупателей на отмену.
При значение true возвращаются только заказы, которые находятся в статусе DELIVERY или PICKUP и которые пользователи решили отменить.
Чтобы подтвердить или отклонить отмену, отправьте запрос PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept.
default: false
onlyEstimatedDelivery (optional)
Query Parameter —
Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки:
true — возвращаются только заказы с неподтвержденной датой доставки.false — фильтрация не применяется.
default: false
buyerType (optional)
Query Parameter — Фильтрация заказов по типу покупателя. default: null
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
},
"orders" : [ {
"delivery" : {
"dispatchType" : "UNKNOWN",
"address" : {
"country" : "country",
"city" : "city",
"postcode" : "postcode",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"house" : "house",
"subway" : "subway",
"phone" : "phone",
"street" : "street",
"district" : "district",
"recipient" : "recipient",
"entryphone" : "entryphone",
"block" : "block",
"entrance" : "entrance",
"floor" : "floor",
"apartment" : "apartment"
},
"liftType" : "NOT_NEEDED",
"deliveryServiceId" : 6,
"estimated" : true,
"dates" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022",
"fromTime" : "fromTime",
"toTime" : "toTime",
"realDeliveryDate" : "23-09-2022"
},
"type" : "DELIVERY",
"serviceName" : "serviceName",
"shipments" : [ {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
}, {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
} ],
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ],
"courier" : {
"vehicleDescription" : "vehicleDescription",
"phone" : "phone",
"phoneExtension" : "phoneExtension",
"fullName" : "fullName",
"vehicleNumber" : "vehicleNumber"
},
"price" : 5.025004791520295,
"outletStorageLimitDate" : "23-09-2022",
"eacType" : "MERCHANT_TO_COURIER",
"liftPrice" : 8.762042012749001,
"eacCode" : "eacCode",
"id" : "id",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"deliveryPartnerType" : "SHOP",
"outletCode" : "outletCode"
},
"notes" : "notes",
"substatus" : "RESERVATION_EXPIRED",
"deliveryTotal" : 1.4658129805029452,
"buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
"creationDate" : "23-09-2022 09:12:41",
"buyerItemsTotal" : 5.962133916683182,
"paymentType" : "PREPAID",
"buyer" : {
"lastName" : "lastName",
"firstName" : "firstName",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"expiryDate" : "23-09-2022 09:12:41",
"buyerTotalBeforeDiscount" : 7.061401241503109,
"itemsTotal" : 6.027456183070403,
"buyerTotal" : 5.637376656633329,
"subsidies" : [ {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
} ],
"paymentMethod" : "CASH_ON_DELIVERY",
"currency" : "RUR",
"fake" : true,
"id" : 0,
"taxSystem" : "OSN",
"cancelRequested" : true,
"items" : [ {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
}, {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
} ],
"status" : "PLACING",
"updatedAt" : "23-09-2022 09:12:41"
}, {
"delivery" : {
"dispatchType" : "UNKNOWN",
"address" : {
"country" : "country",
"city" : "city",
"postcode" : "postcode",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"house" : "house",
"subway" : "subway",
"phone" : "phone",
"street" : "street",
"district" : "district",
"recipient" : "recipient",
"entryphone" : "entryphone",
"block" : "block",
"entrance" : "entrance",
"floor" : "floor",
"apartment" : "apartment"
},
"liftType" : "NOT_NEEDED",
"deliveryServiceId" : 6,
"estimated" : true,
"dates" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022",
"fromTime" : "fromTime",
"toTime" : "toTime",
"realDeliveryDate" : "23-09-2022"
},
"type" : "DELIVERY",
"serviceName" : "serviceName",
"shipments" : [ {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
}, {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
} ],
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ],
"courier" : {
"vehicleDescription" : "vehicleDescription",
"phone" : "phone",
"phoneExtension" : "phoneExtension",
"fullName" : "fullName",
"vehicleNumber" : "vehicleNumber"
},
"price" : 5.025004791520295,
"outletStorageLimitDate" : "23-09-2022",
"eacType" : "MERCHANT_TO_COURIER",
"liftPrice" : 8.762042012749001,
"eacCode" : "eacCode",
"id" : "id",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"deliveryPartnerType" : "SHOP",
"outletCode" : "outletCode"
},
"notes" : "notes",
"substatus" : "RESERVATION_EXPIRED",
"deliveryTotal" : 1.4658129805029452,
"buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
"creationDate" : "23-09-2022 09:12:41",
"buyerItemsTotal" : 5.962133916683182,
"paymentType" : "PREPAID",
"buyer" : {
"lastName" : "lastName",
"firstName" : "firstName",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"expiryDate" : "23-09-2022 09:12:41",
"buyerTotalBeforeDiscount" : 7.061401241503109,
"itemsTotal" : 6.027456183070403,
"buyerTotal" : 5.637376656633329,
"subsidies" : [ {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
} ],
"paymentMethod" : "CASH_ON_DELIVERY",
"currency" : "RUR",
"fake" : true,
"id" : 0,
"taxSystem" : "OSN",
"cancelRequested" : true,
"items" : [ {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
}, {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
} ],
"status" : "PLACING",
"updatedAt" : "23-09-2022 09:12:41"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о заказах.
GetOrdersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/stats/orders
Детальная информация по заказам (getOrdersStats)
Возвращает информацию по заказам на Маркете, в которых есть ваши товары. С помощью нее вы можете собрать статистику по вашим заказам и узнать, например, какие из товаров чаще всего возвращаются покупателями, какие, наоборот, пользуются большим спросом, какая комиссия начисляется за заказы и т. п.
{% note info "" %}
Раньше генерация детальной информации по заказам называлась Отчет по заказам. Сейчас это новый отчет. Подробнее об отчете
{% endnote %}
В одном запросе можно получить информацию не более чем по 200 заказам.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"orders" : [ {
"partnerOrderId" : "partnerOrderId",
"commissions" : [ {
"actual" : 1.2315135367772556,
"type" : "FEE"
}, {
"actual" : 1.2315135367772556,
"type" : "FEE"
} ],
"statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
"payments" : [ {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
}, {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
} ],
"fake" : true,
"deliveryRegion" : {
"name" : "name",
"id" : 6
},
"id" : 0,
"creationDate" : "2000-01-23",
"items" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"initialItems" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"status" : "CANCELLED_BEFORE_PROCESSING",
"paymentType" : "CREDIT"
}, {
"partnerOrderId" : "partnerOrderId",
"commissions" : [ {
"actual" : 1.2315135367772556,
"type" : "FEE"
}, {
"actual" : 1.2315135367772556,
"type" : "FEE"
} ],
"statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
"payments" : [ {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
}, {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
} ],
"fake" : true,
"deliveryRegion" : {
"name" : "name",
"id" : 6
},
"id" : 0,
"creationDate" : "2000-01-23",
"items" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"initialItems" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"status" : "CANCELLED_BEFORE_PROCESSING",
"paymentType" : "CREDIT"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация по заказам.
GetOrdersStatsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offer-prices
Список цен (getPrices)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST campaigns/{campaignId}/offer-prices.
{% endnote %}
Возвращает список цен, установленных вами на товары любым способом: например, через партнерский API или в файле с каталогом.
{% note info %}
Общее количество товаров считается по данным за последние семь дней (не включая сегодня) и не может быть выше 2 миллионов.
{% endnote %}
Способы установки цен описаны в Справке Маркета для продавцов.
|⚙️ Лимит: (количество товаров партнера на витрине) * 25 товаров в сутки|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
archived (optional)
Query Parameter — Фильтр по нахождению в архиве. default: false
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"marketSku" : 0,
"id" : "id",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"marketSku" : 0,
"id" : "id",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"total" : 6,
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список всех товаров с установленными ценами.
GetPricesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-prices
Просмотр цен на указанные товары в магазине (getPricesByOfferIds)
Возвращает список цен на указанные товары в магазине.
{% note warning "Метод только для отдельных магазинов" %}
Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.
Для просмотра базовых цен используйте POST businesses/{businessId}/offer-mappings.
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"offerId" : "offerId",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"offerId" : "offerId",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров с установленными для заданного магазина ценами.
GetPricesByOfferIdsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos/offers
Получение списка товаров, которые участвуют или могут участвовать в акции (getPromoOffers)
Возвращает список товаров, которые участвуют или могут участвовать в акции.
{% note warning %}
В параметре limit не передавайте значение больше 500.
{% endnote %}
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"offerId" : "offerId",
"params" : {
"discountParams" : {
"promoPrice" : 6,
"maxPromoPrice" : 1,
"price" : 0
},
"promocodeParams" : {
"maxPrice" : 5
}
},
"status" : "AUTO",
"autoParticipatingDetails" : {
"campaignIds" : [ 5, 5 ]
}
}, {
"offerId" : "offerId",
"params" : {
"discountParams" : {
"promoPrice" : 6,
"maxPromoPrice" : 1,
"price" : 0
},
"promocodeParams" : {
"maxPrice" : 5
}
},
"status" : "AUTO",
"autoParticipatingDetails" : {
"campaignIds" : [ 5, 5 ]
}
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров, которые участвуют или могут участвовать в акции.
GetPromoOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos
Получение списка акций (getPromos)
Возвращает информацию об акциях Маркета.
По умолчанию возвращаются акции, в которых продавец участвует или может принять участие.
Чтобы получить текущие или завершенные акции, передайте параметр participation.
Типы акций, которые возвращаются в ответе:
- прямая скидка;
- флеш-акция;
- скидка по промокоду.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"promos" : [ {
"period" : {
"dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
"dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
},
"channels" : [ "{}", "{}" ],
"mechanicsInfo" : {
"promocodeInfo" : {
"promocode" : "promocode",
"discount" : 1
},
"type" : "DIRECT_DISCOUNT"
},
"bestsellerInfo" : {
"bestseller" : true,
"entryDeadline" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "name",
"participating" : true,
"id" : "id",
"constraints" : {
"warehouseIds" : [ 5, 5 ]
},
"assortmentInfo" : {
"activeOffers" : 0,
"processing" : true,
"potentialOffers" : 6
}
}, {
"period" : {
"dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
"dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
},
"channels" : [ "{}", "{}" ],
"mechanicsInfo" : {
"promocodeInfo" : {
"promocode" : "promocode",
"discount" : 1
},
"type" : "DIRECT_DISCOUNT"
},
"bestsellerInfo" : {
"bestseller" : true,
"entryDeadline" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "name",
"participating" : true,
"id" : "id",
"constraints" : {
"warehouseIds" : [ 5, 5 ]
},
"assortmentInfo" : {
"activeOffers" : 0,
"processing" : true,
"potentialOffers" : 6
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список акций Маркета.
GetPromosResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/ratings/quality/details
Заказы, которые повлияли на индекс качества (getQualityRatingDetails)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"affectedOrders" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"orderId" : 0,
"description" : "description"
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"orderId" : 0,
"description" : "description"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о заказах, которые повлияли на индекс качества.
GetQualityRatingDetailsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/ratings/quality
Индекс качества магазинов (getQualityRatings)
Возвращает значение индекса качества магазинов и его составляющие.
Подробнее об индексе качества читайте в Справке Маркета для продавцов.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"campaignRatings" : [ {
"campaignId" : 0,
"ratings" : [ {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
}, {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
} ]
}, {
"campaignId" : 0,
"ratings" : [ {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
}, {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Значение индекса качества магазинов и его составляющие.
GetQualityRatingResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /reports/info/{reportId}
Получение заданного отчета (getReportInfo)
Возвращает статус генерации заданного отчета и, если отчет готов, ссылку для скачивания.
Чтобы воспользоваться этим запросом, вначале нужно запустить генерацию отчета. Инструкция
|⚙️ Лимит: 100 запросов в минуту|
|-|
Path parameters
reportId (required)
Path Parameter — Идентификатор отчета, который вы получили после запуска генерации. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"generationRequestedAt" : "2000-01-23T04:56:07.000+00:00",
"file" : "file",
"generationFinishedAt" : "2000-01-23T04:56:07.000+00:00",
"subStatus" : "NO_DATA",
"status" : "PENDING",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Статус генерации отчета и ссылка, если она уже есть.
{% note tip %}
Если статус генерации отчета — FAILED или NO_DATA, проверьте корректность запроса на генерацию. Например, верно ли указан идентификатор магазина, период или номер платежного поручения.
{% endnote %}
GetReportInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}
Информация о невыкупе или возврате (getReturn)
Получает информацию по одному невыкупу или возврату.
|⚙️ Лимит: 10 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"updateDate" : "2000-01-23T04:56:07.000+00:00",
"fastReturn" : true,
"orderId" : 6,
"shipmentRecipientType" : "SHOP",
"refundStatus" : "STARTED_BY_USER",
"logisticPickupPoint" : {
"logisticPartnerId" : 5,
"address" : {
"country" : "Россия",
"city" : "Москва",
"street" : "Стрелецкая улица",
"postcode" : "123518",
"house" : "9к2"
},
"instruction" : "instruction",
"name" : "name",
"id" : 1,
"type" : "WAREHOUSE"
},
"id" : 0,
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"items" : [ {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
}, {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
} ],
"returnType" : "UNREDEEMED",
"shipmentStatus" : "CREATED",
"refundAmount" : 5
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Детали возврата.
GetReturnResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/application
Получение заявления на возврат (getReturnApplication)
Загружает заявление покупателя на возврат товара.
|⚙️ Лимит: 10 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/octet-streamapplication/json
Responses
200
Заявление на возврат.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}
Получение фотографии возврата (getReturnPhoto)
Получает фотографии, которые покупатель приложил к заявлению на возврат товара.
|⚙️ Лимит: 10 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
itemId (required)
Path Parameter — Идентификатор товара в возврате. default: null format: int64
imageHash (required)
Path Parameter — Хеш ссылки изображения для загрузки. default: null
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/octet-streamapplication/json
Responses
200
Фотография возврата.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/returns
Список невыкупов и возвратов (getReturns)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
orderIds (optional)
Query Parameter —
Идентификаторы заказов — для фильтрации результатов.
Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
default: null format: int64
statuses (optional)
Query Parameter —
Статусы возвратов или невыкупов — для фильтрации результатов.
Несколько статусов перечисляются через запятую.
default: null
type (optional)
Query Parameter —
Тип заказа для фильтрации:
-
RETURN — возврат.
-
UNREDEEMED — невыкуп.
Если не указывать, в ответе будут и возвраты, и невыкупы.
default: null
fromDate (optional)
Query Parameter —
Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
Формат: ГГГГ-ММ-ДД.
default: null format: date
toDate (optional)
Query Parameter —
Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
Формат: ГГГГ-ММ-ДД.
default: null format: date
from_date (optional)
Query Parameter —
{% note warning "" %}
Этот параметр устарел. Вместо него используйте fromDate.
{% endnote %}
Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
default: null format: date
to_date (optional)
Query Parameter —
{% note warning "" %}
Этот параметр устарел. Вместо него используйте toDate.
{% endnote %}
Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
default: null format: date
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"nextPageToken" : "nextPageToken"
},
"returns" : [ {
"updateDate" : "2000-01-23T04:56:07.000+00:00",
"fastReturn" : true,
"orderId" : 6,
"shipmentRecipientType" : "SHOP",
"refundStatus" : "STARTED_BY_USER",
"logisticPickupPoint" : {
"logisticPartnerId" : 5,
"address" : {
"country" : "Россия",
"city" : "Москва",
"street" : "Стрелецкая улица",
"postcode" : "123518",
"house" : "9к2"
},
"instruction" : "instruction",
"name" : "name",
"id" : 1,
"type" : "WAREHOUSE"
},
"id" : 0,
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"items" : [ {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
}, {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
} ],
"returnType" : "UNREDEEMED",
"shipmentStatus" : "CREATED",
"refundAmount" : 5
}, {
"updateDate" : "2000-01-23T04:56:07.000+00:00",
"fastReturn" : true,
"orderId" : 6,
"shipmentRecipientType" : "SHOP",
"refundStatus" : "STARTED_BY_USER",
"logisticPickupPoint" : {
"logisticPartnerId" : 5,
"address" : {
"country" : "Россия",
"city" : "Москва",
"street" : "Стрелецкая улица",
"postcode" : "123518",
"house" : "9к2"
},
"instruction" : "instruction",
"name" : "name",
"id" : 1,
"type" : "WAREHOUSE"
},
"id" : 0,
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"items" : [ {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
}, {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
} ],
"returnType" : "UNREDEEMED",
"shipmentStatus" : "CREATED",
"refundAmount" : 5
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Постраничные возвраты партнера.
GetReturnsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}
Получение информации об одной отгрузке (getShipment)
Возвращает информацию об отгрузке по ее идентификатору.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Query parameters
cancelledOrders (optional)
Query Parameter —
Возвращать ли отмененные заказы.
Значение по умолчанию — true. Если возвращать отмененные заказы не нужно, передайте значение false.
default: true
Return type
Example data
Content-Type: application/json
{
"result" : {
"deliveryService" : {
"name" : "name",
"id" : 1
},
"availableActions" : [ "CONFIRM", "CONFIRM" ],
"draftCount" : 7,
"plannedCount" : 9,
"currentStatus" : {
"description" : "description",
"updateTime" : "2000-01-23T04:56:07.000+00:00",
"status" : "OUTBOUND_CREATED"
},
"planIntervalTo" : "2000-01-23T04:56:07.000+00:00",
"externalId" : "externalId",
"warehouse" : {
"address" : "address",
"name" : "name",
"id" : 6
},
"shipmentType" : "IMPORT",
"planIntervalFrom" : "2000-01-23T04:56:07.000+00:00",
"warehouseTo" : {
"address" : "address",
"name" : "name",
"id" : 6
},
"factCount" : 3,
"palletsCount" : {
"fact" : 5,
"planned" : 5
},
"id" : 0,
"orderIds" : [ 2, 2 ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Найденная отгрузка.
GetShipmentResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/info
Получение информации о возможности печати ярлыков (FBS) (getShipmentOrdersInfo)
Возвращает информацию о возможности печати ярлыков-наклеек для заказов в отгрузке.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"orderIdsWithLabels" : [ 0, 0 ],
"orderIdsWithoutLabels" : [ 6, 6 ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация по годным/негодным для печати ярлыков заказам в отгрузке.
GetShipmentOrdersInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers/stocks
Информация об остатках и оборачиваемости (getStocks)
Возвращает данные об остатках товаров (для всех моделей) и об оборачиваемости товаров (для модели FBY).
{% note info "По умолчанию данные по оборачивамости не возращаются" %}
Чтобы они были в ответе, передавайте true в поле withTurnover.
{% endnote %}
|⚙️ Лимит: 100 000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"warehouses" : [ {
"offers" : [ {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"warehouseId" : 0
}, {
"offers" : [ {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"warehouseId" : 0
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Остатки товаров на складах.
GetWarehouseStocksResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-mapping-entries/suggestions
Рекомендованные карточки для товаров (getSuggestedOfferMappingEntries)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/suggestions.
{% endnote %}
Возвращает идентификаторы карточек товаров на Маркете, рекомендованных для ваших товаров.
Каждому товару, который вы размещаете, должна соответствовать карточка товара на Маркете со своим идентификатором — SKU на Маркете. Он указывается в URL карточки товара, после «...sku=», например:
##https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016…##
Чтобы получить для товаров рекомендованные SKU на Маркете, передайте в теле POST-запроса как можно больше информации о них: названия, производителей, штрихкоды, цены и т. д.
Полученные SKU можно передать вместе с информацией о ваших товарах с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/updates.
В одном запросе можно получить не более 500 рекомендаций.
|⚙️ Лимит: 100 000 рекомендаций в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"marketCategoryId" : 4,
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"marketModelId" : 7,
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"marketSkuName" : "marketSkuName",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"marketModelName" : "marketModelName",
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"marketCategoryName" : "marketCategoryName",
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
}, {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"marketCategoryId" : 4,
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"marketModelId" : 7,
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"marketSkuName" : "marketSkuName",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"marketModelName" : "marketModelName",
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"marketCategoryName" : "marketCategoryName",
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о товарах в каталоге.
GetSuggestedOfferMappingEntriesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/suggestions
Просмотр карточек на Маркете, которые подходят вашим товарам (getSuggestedOfferMappings)
Возвращает идентификаторы карточек на Маркете, которые соответствуют товарам с заданными параметрами.
Пользоваться этим запросом необязательно: он просто помогает заранее убедиться, что Маркет верно определяет карточки по предоставленным вами данным.
Как пользоваться запросом
- Передайте Маркету список товаров, которые нужно проверить.
- В ответ вы получите список SKU на Маркете с расшифровкой: названием, идентификатором модели, категорией.
- Если расшифровки мало, вы можете открыть карточку. Для этого перейдите по ссылке вида
https://market.yandex.ru/product/<marketModelId>?sku=<marketSku>.
- Если карточка соответствует товару, значит его можно добавлять в каталог с теми данными, что вы указали. Если карточка определилась неправильно — проверьте данные о товаре. Возможно, их нужно уточнить или дополнить. Кроме того, на этапе добавления товара вы можете указать
marketSKU, который ему подходит по вашему мнению.
{% note info "𝓠 Как определить marketSku товара, найденного на Маркете?" %}
𝓐 Он есть в адресе страницы товара — расположен после sku=.
Например, https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016
{% endnote %}
|⚙️ Лимит: 100 000 товаров в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"offer" : {
"vendor" : "LEVENHUK",
"basicPrice" : {
"value" : 0.9301444243932576
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"description" : "description",
"category" : "category",
"barcodes" : [ "46012300000000", "46012300000000" ],
"vendorCode" : "VNDR-0005A"
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
}, {
"offer" : {
"vendor" : "LEVENHUK",
"basicPrice" : {
"value" : 0.9301444243932576
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"description" : "description",
"category" : "category",
"barcodes" : [ "46012300000000", "46012300000000" ],
"vendorCode" : "VNDR-0005A"
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Подобранные карточки на Маркете.
По результатам проверки товара полученная через этот запрос карточка может быть заменена на другую.
GetSuggestedOfferMappingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-prices/suggestions
Цены для продвижения товаров (getSuggestedPrices)
{% note warning "" %}
Этот метод устарел. Вместо него используйте отчет «Цены на рынке».
{% endnote %}
{% note warning "" %}
Этот метод подходит только тем магазинам, которые устанавливают цены на товары в рублях.
{% endnote %}
Возвращает цены для продвижения товаров, которые вы размещаете на Маркете.
Товары, для которых нужно получить цены, передаются в теле POST-запроса.
Цены для продвижения зависят от цен, установленных на товары другими партнерами. Если один товар поставляют несколько партнеров, на Маркете сначала продается товар с более низкой ценой. Когда закончится товар по низкой цене, начнет продаваться товар по более высокой цене.
Выходные данные содержат для каждого товара несколько цен, соответствующих разным типам продвижения.
Установить цены на товары можно с помощью запроса POST campaigns/{campaignId}/offer-prices/updates или другими способами: например, указать их в файле с каталогом. Также вы можете использовать стратегии для автоматической установки рекомендованных цен или минимальных цен на Маркете.
Подробно об автоматическом управлении ценами рассказано в Справке Маркета для продавцов.
|⚙️ Лимит: 100 000 товаров в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"marketSku" : 0,
"offerId" : "offerId",
"priceSuggestion" : [ {
"price" : 6.027456183070403,
"type" : "BUYBOX"
}, {
"price" : 6.027456183070403,
"type" : "BUYBOX"
} ]
}, {
"marketSku" : 0,
"offerId" : "offerId",
"priceSuggestion" : [ {
"price" : 6.027456183070403,
"type" : "BUYBOX"
}, {
"price" : 6.027456183070403,
"type" : "BUYBOX"
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список цен для продвижения на Маркете.
SuggestPricesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /businesses/{businessId}/warehouses
Список складов и групп складов (getWarehouses)
Возвращает список складов и, если склады объединены, список групп складов. Что такое группы складов и зачем они нужны
Среди прочего запрос позволяет определить идентификатор, который нужно использовать при передаче остатков для группы складов.
|⚙️ Лимит: 100 запросов в минуту|
|-|
Path parameters
Return type
Example data
Content-Type: application/json
{
"result" : {
"warehouses" : [ {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}, {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
} ],
"warehouseGroups" : [ {
"name" : "name",
"warehouses" : [ {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}, {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
} ],
"mainWarehouse" : {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}
}, {
"name" : "name",
"warehouses" : [ {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}, {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
} ],
"mainWarehouse" : {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список складов и групп складов.
GetWarehousesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/identifiers
Передача кодов маркировки единиц товара (provideOrderItemIdentifiers)
{% note warning "Этот запрос только для DBS" %}
Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.
{% endnote %}
Передает Маркету коды маркировки для единиц товара в указанном заказе.
Принимаются коды следующих типов:
- Коды «Честного знака».
- УИН для ювелирных изделий.
- РНПТ и ГТД для импортных прослеживаемых товаров.
{% note warning %}
Прежде чем работать с этим методом, обязательно прочтите статью о работе с маркируемыми товарами.
{% endnote %}
Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"items" : [ {
"offerName" : "offerName",
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"price" : 1.4658129805029452,
"vat" : "NO_VAT",
"count" : 6,
"offerId" : "offerId",
"id" : 0
}, {
"offerName" : "offerName",
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"price" : 1.4658129805029452,
"vat" : "NO_VAT",
"count" : 6,
"offerId" : "offerId",
"id" : 0
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ 200 обозначает, что коды успешно записались. Ответ содержит краткие сведения о промаркированных товарах.
ProvideOrderItemIdentifiersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /businesses/{businessId}/bids
Включение буста продаж и установка ставок (putBidsForBusiness)
Запускает буст продаж — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.
{% cut "Как в кабинете выглядит кампания, созданная через API" %}
{% endcut %}
При первом использовании запроса Маркет: создаст единую на все магазины бизнес-аккаунта кампанию, добавит в нее товары с указанными ставками, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.
Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.
Запрос всегда работает с одной и той же созданной через API кампанией. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. Другими кампаниями управлять через API не получится. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.
Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.
Внести другие изменения в созданную через API кампанию можно в кабинете:
- выключить или включить кампанию;
- изменить ее название;
- выключить или включить ценовую стратегию.
Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.
Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.
{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}
𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.
{% endnote %}
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Все получилось: ставки установлены или обновлены. Если нужно, добавлены новые товары и запущена кампания.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/bids
Включение буста продаж и установка ставок для магазина (putBidsForCampaign)
Запускает буст продаж в указанном магазине — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.
При первом использовании запроса Маркет: создаст кампанию, добавит в нее товары с указанными ставками для заданного магазина, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.
Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.
Запрос всегда работает с одной и той же кампанией, созданной через этот запрос или PUT businesses/{businessId}/bids. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.
Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.
Внести другие изменения в созданную через API кампанию можно в кабинете:
- выключить или включить кампанию;
- изменить ее название;
- выключить или включить ценовую стратегию.
Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.
Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.
{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}
𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.
{% endnote %}
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/feeds/{feedId}/refresh
Сообщить, что прайс-лист обновился (refreshFeed)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет сообщить, что магазин обновил прайс-лист. После этого Маркет начнет обновление данных на сервисе.
- Магазин обновляет прайс-лист, ссылку на который он указал в кабинете.
- Магазин отправляет Маркету запрос методом
POST campaigns/{campaignId}/feeds/{feedId}/refresh.
- Маркет начинает обновление данных магазина на сервисе.
{% note alert %}
Запрос работает только для включенных магазинов. Если магазин выключен, данные на Маркете не обновятся, даже если HTTP-код — 200 OK. Проверить статус магазина можно с помощью базовых запросов или на странице бизнес-аккаунта.
{% endnote %}
|⚙️ Лимит: 3 запроса в час для одного прайс-листа|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /regions/{regionId}/children
Информация о дочерних регионах (searchRegionChildren)
Возвращает информацию о регионах, являющихся дочерними по отношению к региону, идентификатор которого указан в запросе.
Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).
Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.
|⚙️ Лимит: 50 000 запросов в час|
|-|
Path parameters
regionId (required)
Path Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
Query parameters
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"regions" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Регионы, являющиеся дочерними к указанному в запросе.
GetRegionWithChildrenResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /regions/{regionId}
Информация о регионе (searchRegionsById)
Возвращает информацию о регионе.
Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).
Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.
|⚙️ Лимит: 50 000 запросов в час|
|-|
Path parameters
regionId (required)
Path Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"regions" : [ {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}, {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Найденный регион.
GetRegionsResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Поиск регионов по их имени (searchRegionsByName)
Возвращает информацию о регионе, удовлетворяющем заданным в запросе условиям поиска.
Если найдено несколько регионов, удовлетворяющих условиям поиска, возвращается информация по каждому найденному региону (но не более десяти регионов) для возможности определения нужного региона по родительским регионам.
Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).
Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.
|⚙️ Лимит: 50 000 запросов в час|
|-|
Query parameters
name (required)
Query Parameter —
Название региона.
Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, Москва.
default: null
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"regions" : [ {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}, {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список найденных регионов.
GetRegionsResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/first-mile/shipments
Получение информации о нескольких отгрузках (searchShipments)
Возвращает информацию об отгрузках по заданным параметрам:
- дате;
- статусу;
- идентификаторам заказов.
Результаты возвращаются постранично.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"nextPageToken" : "nextPageToken"
},
"shipments" : [ {
"deliveryService" : {
"name" : "name",
"id" : 1
},
"draftCount" : 1,
"plannedCount" : 5,
"planIntervalTo" : "2000-01-23T04:56:07.000+00:00",
"externalId" : "externalId",
"warehouse" : {
"address" : "address",
"name" : "name",
"id" : 6
},
"shipmentType" : "IMPORT",
"planIntervalFrom" : "2000-01-23T04:56:07.000+00:00",
"statusDescription" : "statusDescription",
"warehouseTo" : {
"address" : "address",
"name" : "name",
"id" : 6
},
"factCount" : 5,
"palletsCount" : {
"fact" : 5,
"planned" : 5
},
"id" : 0,
"orderIds" : [ 6, 6 ],
"statusUpdateTime" : "2000-01-23T04:56:07.000+00:00",
"status" : "OUTBOUND_CREATED"
}, {
"deliveryService" : {
"name" : "name",
"id" : 1
},
"draftCount" : 1,
"plannedCount" : 5,
"planIntervalTo" : "2000-01-23T04:56:07.000+00:00",
"externalId" : "externalId",
"warehouse" : {
"address" : "address",
"name" : "name",
"id" : 6
},
"shipmentType" : "IMPORT",
"planIntervalFrom" : "2000-01-23T04:56:07.000+00:00",
"statusDescription" : "statusDescription",
"warehouseTo" : {
"address" : "address",
"name" : "name",
"id" : 6
},
"factCount" : 5,
"palletsCount" : {
"fact" : 5,
"planned" : 5
},
"id" : 0,
"orderIds" : [ 6, 6 ],
"statusUpdateTime" : "2000-01-23T04:56:07.000+00:00",
"status" : "OUTBOUND_CREATED"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Найденные отгрузки.
SearchShipmentsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/file/send
Отправка файла в чат (sendFileToChat)
Отправляет файл в чат с покупателем.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Query parameters
chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
Form parameters
file (required)
Form Parameter — Содержимое файла. Максимальный размер файла — 5 Мбайт. default: null format: binary
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ. Означает, что файл отправлен.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/message
Отправка сообщения в чат (sendMessageToChat)
Отправляет сообщение в чат с покупателем.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ. Означает, что сообщение отправлено.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/feeds/{feedId}/params
Изменение параметров прайс-листа (setFeedParams)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет магазину изменить параметры прайс-листа.
Чтобы отредактировать параметр прайс-листа, передайте в теле запроса: name (название параметра) и value (значение параметра).
Чтобы отменить установленное значение, передайте в теле запроса: name (название параметра) и delete=true (удалить значение).
|⚙️ Лимит: 3 запроса в час для одного прайс-листа|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Статус выполнения операции.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/boxes
Подготовка заказа (setOrderBoxLayout)
{% note tip "Подходит и для DBS" %}
Запрос предназначен для работы с FBS-заказами, но вы можете использовать его для обработки DBS-заказов, если это удобно.
{% endnote %}
Позволяет выполнить три операции:
- передать Маркету информацию о распределении товаров по коробкам;
- передать Маркету коды маркировки для товаров;
- удалить товар из заказа, если его не оказалось на складе.
Если нужно что-то поправить в переданных данных, просто повторите запрос — это можно делать сколько угодно раз до перевода заказа в статус Готов к отгрузке. ⚠️ Если вы меняете раскладку уже после печати и расклейки ярлыков, не забудье перепечатать их и наклеить заново.
Как передать информацию о распределении товаров
В этом запросе вам нужно передать Маркету список коробок и указать, какие именно товары лежат в каждой из них. Коробки могут быть двух типов:
-
Содержащие товары целиком. Такая коробка может содержать сколько угодно единиц любых товаров.
-
Содержащие часть товара. Такие коробки содержат по одной части одного товара. Например, одна содержит внешний блок кондиционера, а другая — внутренний блок.
⚠️ Одна коробка не может содержать и товары целиком, и части товаров.
Как передавать коды маркировки
Если в заказе есть товары, подлежащие маркировке, в запросе нужно передать соответствующие уникальные коды. Что такое маркировка?
Принимаются коды следующих типов:
- Коды «Честного знака».
- УИН для ювелирных изделий.
- РНПТ и ГТД для импортных прослеживаемых товаров.
Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй.
Если товар едет в нескольких коробках, код маркировки нужно передать для каждой из них.
Как удалить товар из заказа
Чтобы удалить товар из заказа:
- Добавьте в запрос
allowRemove: true.
- Передайте распределение по коробкам без товара, который нужно удалить.
{% note warning "Удаление нельзя отменить" %}
Эта операция необратима: покупатель сразу получит уведомление, а состав заказа изменится.
{% endnote %}
Чтобы удалить позицию целиком, не передавайте соответствующий OrderBoxLayoutItemDTO. Чтобы уменьшить количество товара, передайте уменьшенное значение в поле fullCount.
Нельзя удалить или уменьшить количество товара, если он:
- добавлен по акции;
- составляет 99% стоимости заказа;
- единственный товар в заказе.
Если вы не можете отгрузить такой товар, отмените заказ. Для этого отправьте запрос методом PUT campaigns/{campaignId}/orders/{orderId}/status и передайте статус заказа CANCELLED с причиной отмены SHOP_FAILED.
{% note info "Увеличить заказ нельзя" %}
С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим.
{% endnote %}
Примеры
{% cut "Товар умещается в коробку" %}
Вот как будет выглядеть запрос, если в одной коробке едут:
- три единицы одного товара, требующего маркировки;
- одна единица другого товара, не требущего маркировки.
{
"boxes": [
{
"items": [
{
"id": 123456,
"fullCount": 3,
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
},
{
"cis": "010304109478gftJ14545762!\u001dhGt264"
},
{
"cis": "010304109478fRs28323ks23!\u001dhet201"
}
]
},
{
"id": 654321,
"fullCount": 1
}
]
}
]
}
{% endcut %}
{% cut "Товар едет в разных коробках" %}
Вот как будет выглядеть запрос, если товар едет в двух коробках:
{
"boxes": [
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 2,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
}
]
}
{% endcut %}
{% cut "Одинаковые товары, где каждый едет в нескольких коробках" %}
Вот как будет выглядеть запрос, если каждый из двух одинаковых товаров едет в двух коробках:
{
"boxes": [
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 2,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 2,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
}
]
}
{% endcut %}
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"boxes" : [ {
"items" : [ {
"partialCount" : {
"current" : 1,
"total" : 2
},
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
} ],
"id" : 0,
"fullCount" : 1
}, {
"partialCount" : {
"current" : 1,
"total" : 2
},
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
} ],
"id" : 0,
"fullCount" : 1
} ],
"boxId" : 5
}, {
"items" : [ {
"partialCount" : {
"current" : 1,
"total" : 2
},
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
} ],
"id" : 0,
"fullCount" : 1
}, {
"partialCount" : {
"current" : 1,
"total" : 2
},
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
} ],
"id" : 0,
"fullCount" : 1
} ],
"boxId" : 5
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ придет переданная раскладка с идентификаторами коробок — они понадобятся для запроса ярлыков.
SetOrderBoxLayoutResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes
Передача количества грузовых мест в заказе (setOrderShipmentBoxes)
{% note warning "Этот запрос только для DBS" %}
Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.
{% endnote %}
Отгружаемый Маркету заказ может не влезть в одну коробку или упаковку — в этом случае получается, что он занимает несколько грузовых мест.
Количество грузовых мест нужно обязательно передавать Маркету, если оно не равно 1. Это делается перед переводом его в статус Готов к отгрузке. Подробно о том, что в какой момент нужно передавать, рассказано в пошаговой инструкции.
Метод устроен немного нестандартно: количество задается длиной массива пустых объектов.
Раньше метод требовал передачи большего количества данных. Запросы, оформленные по старому образцу, работают, но лучше делать по-новому.
{% cut "Как было раньше" %}
Структура тела PUT-запроса:
{
"boxes":
[
{
"fulfilmentId": "{string}",
"weight": {int64},
"width": {int64},
"height": {int64},
"depth": {int64},
"items":
[
{
"id": {int64},
"count": {int32}
},
...
]
},
...
]
}
| Параметр | Тип | Значение |
| ----------- | ----------- | ----------- |
| boxes | | Список грузовых мест. |
Параметры, вложенные в boxes
| Параметр | Тип | Значение |
| ----------- | ----------- | ----------- |
| fulfilmentId | String | Идентификатор грузового места в информационной системе магазина. Сформируйте идентификатор по шаблону: номер заказа на Маркете-номер грузового места. Например, 7206821‑1, 7206821‑2 и т. д. |
| weight | Int64 | Масса брутто грузового места (суммарная масса упаковки и содержимого) в граммах. |
| width | Int64 | Ширина грузового места в сантиметрах. |
| height | Int64 | Высота грузового места в сантиметрах. |
| depth | Int64 | Глубина грузового места в сантиметрах. |
| items | Int64 | Список товаров в грузовом месте. |
Параметры, вложенные в items
| Параметр | Тип | Значение |
| ----------- | ----------- | ----------- |
| id | Int64 | Идентификатор товара в рамках заказа. |
| count | Int32 | Количество единиц товара в грузовом месте. |
{% endcut %}
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
shipmentId (required)
Path Parameter — Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 0
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 0
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Имеет значение только тип ответа. Если ответ
ОК, количество грузомест записано.
SetOrderShipmentBoxesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallets
Передача количества упаковок в отгрузке (setShipmentPalletsCount)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Имеет значение только тип ответа. Если ответ
ОК, количество упаковок записано.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/skip-reaction
Отказ от ответа на отзывы (skipGoodsFeedbacksReaction)
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/transfer
Перенос заказов в следующую отгрузку (transferOrdersFromShipment)
Переносит указанные заказы из указанной отгрузки в следующую отгрузку. Что такое отгрузка?
Используйте этот запрос, если не успеваете собрать и упаковать заказы вовремя.
{% note warning "Такие переносы снижают индекс качества магазина" %}
Этот запрос предназначен для исключительных случаев. Если вы будете переносить заказы слишком часто, магазин столкнется с ограничениями. Что за ограничения?
{% endnote %}
Переносить заказы можно, если до формирования отгрузки осталось больше получаса.
Перенос происходит не мгновенно, а занимает несколько минут.
|⚙️ Лимит: 200 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Запрос на перенос заказов проверен и принят, и они будут перенесены спустя несколько минут.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-prices/updates
Установка цен на товары во всех магазинах (updateBusinessPrices)
Устанавливает базовые цены. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Маркет принял информацию о новых ценах.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers/update
Изменение условий продажи товаров в магазине (updateCampaignOffers)
Изменяет параметры продажи товаров в конкретном магазине: доступность товара, условия доставки и самовывоза, применяемую ставку НДС.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ 200 обозначает, что новые параметры получены Маркетом и скоро вступят в силу.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/comments/update
Добавление нового или изменение созданного комментария (updateGoodsFeedbackComment)
Добавляет новый комментарий магазина или изменяет комментарий, который магазин оставлял ранее.
Для создания комментария к отзыву передайте только идентификатор отзыва feedbackId.
Чтобы добавить комментарий к другому комментарию, передайте:
feedbackId — идентификатор отзыва;comment.parentId — идентификатор родительского комментария.
Чтобы изменить комментарий, передайте:
feedbackId— идентификатор отзыва;comment.id — идентификатор комментария, который нужно изменить.
Если передать одновременно comment.parentId и comment.id, будет изменен существующий комментарий.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 0,
"text" : "text",
"canModify" : true,
"parentId" : 6,
"status" : "PUBLISHED"
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о добавленном или измененном комментарии.
UpdateGoodsFeedbackCommentResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-cards/update
Редактирование категорийных характеристик товара (updateOfferContent)
Редактирует характеристики товара, которые специфичны для категории, к которой он относится.
{% note warning "Здесь только то, что относится к конкретной категории" %}
Если вам нужно изменить основные параметры товара (название, описание, изображения, видео, производитель, штрихкод), воспользуйтесь запросом POST businesses/{businessId}/offer-mappings/update.
{% endnote %}
Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"results" : [ {
"warnings" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ]
}, {
"warnings" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ]
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Запрос выполнен корректно, данные обработаны.
{% note warning "Ответ 200 сам по себе не значит, что переданные значения корректны" %}
Обязательно посмотрите детали ответа: status и перечень ошибок, если он есть.
Даже если ошибка допущена в характеристиках всего одного товара, никакие изменения из запроса в каталог не попадут.
{% endnote %}
Если в status вернулось ERROR, убедитесь, что:
- все обязательные характеристики заполнены;
- характеристики действительно существуют в указанных категориях;
- значения соответствуют характеристикам;
- ваши собственные значения имеют нужный тип данных.
Найти проблемы помогут поля errors и warnings.
UpdateOfferContentResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-mapping-entries/updates
Добавление и редактирование товаров в каталоге (updateOfferMappingEntries)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/update.
{% endnote %}
Добавляет товары, указанные в запросе, в ваш каталог товаров и редактирует уже имеющиеся товары.
Информацию о товарах нужно передать в теле POST-запроса.
У каждого товара должен быть ваш SKU — уникальный код, который вы используете для идентификации товара:
- Чтобы добавить в каталог новый товар, укажите в параметре
shopSku ваш SKU, которого еще нет в каталоге.
- Чтобы отредактировать товар из каталога, укажите в параметре
shopSku ваш SKU этого товара в каталоге.
В обоих случаях в запросе нужно передать полное описание товара, даже если вы хотите изменить только несколько характеристик.
Если вы знаете, какой карточке товара на Маркете соответствует ваш товар, укажите ее идентификатор (SKU на Маркете) во входном параметре mapping. Получить SKU на Маркете рекомендованной карточки товара можно с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/suggestions или через кабинет. Если SKU на Маркете не указан, сотрудники Маркета сами подберут или создадут подходящую карточку товара, либо у него появится статус NEED_CONTENT (нужно найти карточку или создать ее самостоятельно) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.
Перед публикацией товары проходят модерацию. Если в одном из отправленных товаров найдена ошибка, ответ на запрос будет иметь HTTP-код 400 Bad Request, и ни один из товаров не отправится на модерацию. При этом если вы не передадите все обязательные параметры для какого‑либо товара, после модерации у него появится статус NEED_INFO (в описании товара не хватает информации) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.
В одном запросе можно добавить не более 500 товаров.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5 000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Статус выполнения операции.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/update
Добавление товаров в каталог и изменение информации о них (updateOfferMappings)
Добавляет товары в каталог, передает их категории на Маркете и характеристики, необходимые для этих категории. Также редактирует информацию об уже имеющихся товарах.
Список категорий Маркета можно получить с помощью запроса POST categories/tree, а характеристики товаров по категориям с помощью POST category/{categoryId}/parameters.
Чтобы добавить новый товар, передайте его с новым идентификатором, который раньше никогда не использовался в каталоге. Старайтесь сразу передать как можно больше информации — она потребуется Маркету для подбора подходящей карточки или создания новой. Если известно, какой карточке на Маркете соответствует товар, можно сразу указать идентификатор этой карточки (SKU на Маркете) в поле marketSKU.
Для новых товаров обязательно укажите параметры: offerId, name, marketCategoryId или category, pictures, vendor, description.
Чтобы отредактировать информацию о товаре, передайте новые данные, указав в offerId соответствующий ваш SKU. Поля, в которых ничего не меняется, можно не передавать.
Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.
Параметр offerId должен быть уникальным для всех товаров, которые вы передаете.
{% note warning "Правила использования SKU" %}
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
{% endnote %}
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"results" : [ {
"warnings" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ]
}, {
"warnings" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ]
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Все обязательные поля товаров заполнены, поэтому новые товары и внесенные изменения сохранены в каталоге.
UpdateOfferMappingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/items
Удаление товара из заказа или уменьшение числа единиц (updateOrderItems)
{% note warning "Этот запрос только для DBS" %}
Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.
{% endnote %}
Изменяет состав заказа, если позволяет выбранная служба доставки, в случаях:
- покупатель уменьшил количество товара;
- магазин не может поставить все товары в заказе.
Для этого заказ должен находится в статусе "status": "PROCESSING" этапа обработки "substatus": "STARTED". После передачи статуса "substatus": "READY_TO_SHIP" изменить состав невозможно.
Если одинаковых товаров несколько, для уменьшения количества передайте обновленное значение в атрибуте count параметра item.
Чтобы полностью удалить товар из заказа:
- передайте значение
0; или
- не передавайте параметр
item.
Нельзя удалить или уменьшить количество товара, если он:
- добавлен по акции;
- составляет 99% стоимости заказа;
- единственный товар в заказе.
Если необходимо удалить такой товар, отмените заказ. Для этого отправьте запрос методом PUT campaigns/{campaignId}/orders/{orderId}/status и передайте статус заказа CANCELLED с причиной отмены SHOP_FAILED.
{% note info "Увеличить заказ нельзя" %}
С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим.
{% endnote %}
Возврат денег покупателю
Если покупатель оплатил товар при оформлении, Маркет вернет ему деньги за удаленные из заказа товары в течение двух дней:
-
при оплате банковской картой — с момента, когда магазин переведет заказ в статус SHIPPED;
-
при оплате через Apple Pay или Google Pay — с момента, когда магазин удалит товар из заказа.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Маркет успешно обработал ваш запрос. Выходные данные не ожидаются.
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/status
Изменение статуса одного заказа (updateOrderStatus)
Изменяет статус заказа. Возможные изменения статусов:
- Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "STARTED" нужно перевести в статус "status": "PROCESSING" и этап обработки "substatus": "READY_TO_SHIP".
- Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "STARTED" нужно перевести в статус "status": "CANCELLED" с причиной отмены заказа "substatus": "SHOP_FAILED".
- Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "READY_TO_SHIP" нужно перевести в статус "status": "CANCELLED" с причиной отмены заказа "substatus": "SHOP_FAILED".
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"order" : {
"delivery" : {
"dispatchType" : "UNKNOWN",
"address" : {
"country" : "country",
"city" : "city",
"postcode" : "postcode",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"house" : "house",
"subway" : "subway",
"phone" : "phone",
"street" : "street",
"district" : "district",
"recipient" : "recipient",
"entryphone" : "entryphone",
"block" : "block",
"entrance" : "entrance",
"floor" : "floor",
"apartment" : "apartment"
},
"liftType" : "NOT_NEEDED",
"deliveryServiceId" : 6,
"estimated" : true,
"dates" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022",
"fromTime" : "fromTime",
"toTime" : "toTime",
"realDeliveryDate" : "23-09-2022"
},
"type" : "DELIVERY",
"serviceName" : "serviceName",
"shipments" : [ {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
}, {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
} ],
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ],
"courier" : {
"vehicleDescription" : "vehicleDescription",
"phone" : "phone",
"phoneExtension" : "phoneExtension",
"fullName" : "fullName",
"vehicleNumber" : "vehicleNumber"
},
"price" : 5.025004791520295,
"outletStorageLimitDate" : "23-09-2022",
"eacType" : "MERCHANT_TO_COURIER",
"liftPrice" : 8.762042012749001,
"eacCode" : "eacCode",
"id" : "id",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"deliveryPartnerType" : "SHOP",
"outletCode" : "outletCode"
},
"notes" : "notes",
"substatus" : "RESERVATION_EXPIRED",
"deliveryTotal" : 1.4658129805029452,
"buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
"creationDate" : "23-09-2022 09:12:41",
"buyerItemsTotal" : 5.962133916683182,
"paymentType" : "PREPAID",
"buyer" : {
"lastName" : "lastName",
"firstName" : "firstName",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"expiryDate" : "23-09-2022 09:12:41",
"buyerTotalBeforeDiscount" : 7.061401241503109,
"itemsTotal" : 6.027456183070403,
"buyerTotal" : 5.637376656633329,
"subsidies" : [ {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
} ],
"paymentMethod" : "CASH_ON_DELIVERY",
"currency" : "RUR",
"fake" : true,
"id" : 0,
"taxSystem" : "OSN",
"cancelRequested" : true,
"items" : [ {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
}, {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
} ],
"status" : "PLACING",
"updatedAt" : "23-09-2022 09:12:41"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В случае успешного изменения статуса заказа возвращается обновленная информация о заказе.
UpdateOrderStatusResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/status-update
Изменение статусов нескольких заказов (updateOrderStatuses)
Изменяет статусы нескольких заказов.
Возможные изменения статусов:
- Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса
"status": "PROCESSING"и этапа обработки "substatus": "STARTED" нужно перевести в статус "status": "PROCESSING" и этап обработки "substatus": "READY_TO_SHIP".
- Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "STARTED" нужно перевести в статус "status": "CANCELLED" с причиной отмены заказа "substatus": "SHOP_FAILED".
- Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "READY_TO_SHIP" нужно перевести в статус "status": "CANCELLED" с причиной отмены заказа "substatus": "SHOP_FAILED".
Максимальное количество заказов, у которых можно изменить статус в одном запросе, — 30.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"orders" : [ {
"substatus" : "RESERVATION_EXPIRED",
"updateStatus" : "OK",
"id" : 0,
"status" : "PLACING",
"errorDetails" : "errorDetails"
}, {
"substatus" : "RESERVATION_EXPIRED",
"updateStatus" : "OK",
"id" : 0,
"status" : "PLACING",
"errorDetails" : "errorDetails"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Возвращается информация об обновленных статусах заказов.
UpdateOrderStatusesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-prices/updates
Установка цен на товары в конкретном магазине (updatePrices)
Устанавливает цены на товары в магазине. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.
{% note warning "Метод только для отдельных магазинов" %}
Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.
Для управления базовыми ценами используйте POST businesses/{businessId}/offer-prices/updates.
{% endnote %}
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Маркет принял информацию о новых ценах.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos/offers/update
Добавление товаров в акцию или изменение их цен (updatePromoOffers)
Добавляет товары в акцию или изменяет цены на товары, которые участвуют в акции.
Изменения начинают действовать в течение 4–6 часов.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"rejectedOffers" : [ {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
}, {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
} ],
"warningOffers" : [ {
"warnings" : [ {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
}, {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
} ],
"offerId" : "offerId"
}, {
"warnings" : [ {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
}, {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
} ],
"offerId" : "offerId"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Результат добавления товаров в акцию или обновления их цен.
UpdatePromoOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/offers/stocks
Передача информации об остатках (updateStocks)
Передает данные об остатках товаров на витрине.
Обязательно указывайте SKU в точности так, как он указан в каталоге. Например, 557722 и 0557722 — это два разных SKU.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 100 000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/hidden-offers
Скрытие товаров и настройки скрытия (addHiddenOffers)
Скрывает товары магазина на Маркете.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Настройки скрытия получены и скоро вступят в силу.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/archive
Добавление товаров в архив (addOffersToArchive)
Помещает товары в архив. Товары, помещенные в архив, скрыты с витрины во всех магазинах кабинета.
{% note warning "В архив нельзя отправить товар, который хранится на складе Маркета" %}
Вначале такой товар нужно распродать или вывезти.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notArchivedOffers" : [ {
"offerId" : "offerId",
"error" : "OFFER_HAS_STOCKS"
}, {
"offerId" : "offerId",
"error" : "OFFER_HAS_STOCKS"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если некоторые товары добавить в архив не удалось, в ответе 200 будет их список.
Список успешно добавленных товаров не возвращается.
AddOffersToArchiveResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /tariffs/calculate
Калькулятор стоимости услуг (calculateTariffs)
Рассчитывает стоимость услуг Маркета для товаров с заданными параметрами. Порядок товаров в запросе и ответе сохраняется, чтобы определить,
для какого товара рассчитана стоимость услуги.
Обратите внимание: калькулятор осуществляет примерные расчеты. Финальная стоимость для каждого заказа зависит от предоставленных услуг.
В запросе можно указать либо параметр campaignId, либо sellingProgram. Совместное использование параметров приведет к ошибке.
|⚙️ Лимит: 100 запросов в минуту|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"offer" : {
"quantity" : 1,
"price" : 0.6027456183070403,
"length" : 0.14658129805029452,
"width" : 0.5962133916683182,
"weight" : 0.23021358869347652,
"categoryId" : 0,
"height" : 0.5637376656633328
},
"tariffs" : [ {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
}, {
"offer" : {
"quantity" : 1,
"price" : 0.6027456183070403,
"length" : 0.14658129805029452,
"width" : 0.5962133916683182,
"weight" : 0.23021358869347652,
"categoryId" : 0,
"height" : 0.5637376656633328
},
"tariffs" : [ {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Стоимость услуг.
CalculateTariffsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/price-quarantine/confirm
Удаление товара из карантина по цене в кабинете (confirmBusinessPrices)
Подтверждает основную цену на товары, которые попали в карантин, и удаляет их из карантина.
Основная цена задается в каталоге и действует во всех магазинах кабинета.
Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин
Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST businesses/{businessId}/price-quarantine.
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ 200 обозначает, что цены подтверждены.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/price-quarantine/confirm
Удаление товара из карантина по цене в магазине (confirmCampaignPrices)
Подтверждает в заданном магазине цену на товары, которые попали в карантин, и удаляет их из карантина.
Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин
Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST campaigns/{campaignId}/price-quarantine.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ 200 обозначает, что цены подтверждены.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/new
Создание нового чата с покупателем (createChat)
Создает новый чат с покупателем.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"chatId" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Все получилось: чат создан.
CreateChatResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers/delete
Удаление товаров из ассортимента магазина (deleteCampaignOffers)
Удаляет заданные товары из заданного магазина.
{% note warning "Запрос удаляет товары именно из конкретного магазина" %}
На продажи в других магазинах и на наличие товара в общем каталоге он не влияет.
{% endnote %}
Товар не получится удалить, если он хранится на складах Маркета.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notDeletedOfferIds" : [ null, null ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине.
DeleteCampaignOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/comments/delete
Удаление комментария к отзыву (deleteGoodsFeedbackComment)
Удаляет комментарий магазина.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/hidden-offers/delete
Возобновление показа товаров (deleteHiddenOffers)
Возобновляет показ скрытых вами товаров магазина на Маркете.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Показ товаров возобновлен.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/delete
Удаление товаров из каталога (deleteOffers)
Удаляет товары из каталога.
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notDeletedOfferIds" : [ null, null ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине.
DeleteOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/unarchive
Удаление товаров из архива (deleteOffersFromArchive)
Восстанавливает товары из архива.
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notUnarchivedOfferIds" : [ null, null ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если некоторые товары восстановить из архива не удалось, в ответе 200 будет их список.
Список успешно восстановленных товаров не возвращается.
DeleteOffersFromArchiveResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos/offers/delete
Удаление товаров из акции (deletePromoOffers)
Убирает товары из акции.
Изменения начинают действовать в течение 4–6 часов.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"rejectedOffers" : [ {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
}, {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Результат удаления товаров из акции.
DeletePromoOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/boost-consolidated/generate
Отчет по бусту продаж (generateBoostConsolidatedReport)
Запускает генерацию сводного отчета по бусту продаж за заданный период. Отчет содержит информацию по всем кампаниям, созданным и через API, и в кабинете.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/competitors-position/generate
Отчет «Конкурентная позиция» (generateCompetitorsPositionReport)
Запускает генерацию отчета «Конкурентная позиция» за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
{% note info "Значение -1 в отчете" %}
Если в CSV-файле в столбце POSITION стоит -1, в этот день не было заказов с товарами в указанной категории.
{% endnote %}
|⚙️ Лимит: 10 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/goods-feedback/generate
Отчет по отзывам о товарах (generateGoodsFeedbackReport)
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/goods-movement/generate
Отчет по движению товаров (generateGoodsMovementReport)
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/goods-realization/generate
Отчет по реализации (generateGoodsRealizationReport)
Запускает генерацию отчета по реализации за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/goods-turnover/generate
Отчет по оборачиваемости (generateGoodsTurnoverReport)
Запускает генерацию отчета по оборачиваемости за заданную дату. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/prices/generate
Отчет «Цены на рынке» (generatePricesReport)
Запускает генерацию отчета «Цены на рынке».
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/shelf-statistics/generate
Отчет по полкам (generateShelfsStatisticsReport)
Запускает генерацию сводного отчета по полкам — рекламным блокам с баннером или видео и набором товаров. Подробнее о них читайте в Справке Маркета для продавцов.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/shows-sales/generate
Отчет «Аналитика продаж» (generateShowsSalesReport)
Запускает генерацию отчета «Аналитика продаж» за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 10 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/stocks-on-warehouses/generate
Отчет по остаткам на складах (generateStocksOnWarehousesReport)
Запускает генерацию отчета по остаткам на складах. Отчет содержит данные:
- Для модели FBY — об остатках на складах Маркета.
- Для остальных моделей — об остатках на соответствующем складе магазина.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/united-marketplace-services/generate
Отчет по стоимости услуг (generateUnitedMarketplaceServicesReport)
Запускает генерацию отчета по стоимости услуг за заданный период. Что это за отчет
Тип отчета зависит от того, какие поля заполнены в запросе:
|Тип отчета |Какие поля нужны |
|-----------------------------|---------------------------------|
|По дате начисления услуги |dateFrom и dateTo |
|По дате формирования акта |year и month |
Заказать отчеты обоих типов одним запросом нельзя.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/united-netting/generate
Отчет по платежам (generateUnitedNettingReport)
Запускает генерацию отчета по платежам за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
Тип отчета зависит от того, какие поля заполнены в запросе:
|Тип отчета |Какие поля нужны |
|-------------------------|---------------------------------------|
|О платежах за период |dateFrom и dateTo |
|О платежном поручении |bankOrderId и bankOrderDateTime |
Заказать отчеты обоих типов одним запросом нельзя.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/united-orders/generate
Отчет по заказам (generateUnitedOrdersReport)
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offers/all
Все предложения магазина (getAllOffers)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет максимально быстро получить информацию обо всех предложениях магазина, размещенных на Маркете. Возвращает результат в виде сегментов нефиксированного размера.
В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Яндекс Маркета, с которой соотнесено предложение, а также аукционные ставки на него.
{% note info %}
Количество предложений считается по данным за последние семь дней (не включая сегодня).
Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
chunk (optional)
Query Parameter —
Номер сегмента с результатами.
Значение по умолчанию: 0.
{% note info %}
Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.
{% endnote %}
{% note alert %}
Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать chunk=0 и т. д.
{% endnote %}
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"offers" : [ {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
}, {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
} ]
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Предложения магазина.
GetAllOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/bids/info
Информация об установленных ставках (getBidsInfoForBusiness)
Возвращает значения ставок для заданных товаров.
{% note warning "" %}
В ответе возвращаются значения только тех ставок, которые вы установили через запрос PUT businesses/{businessId}/bids. Получить информацию по кампаниям, созданным в кабинете, не получится.
{% endnote %}
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"bids" : [ {
"sku" : "sku",
"bid" : 570
}, {
"sku" : "sku",
"bid" : 570
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Значения ставок для заданных товаров. В ответ попадают только товары, на которые установлены ставки.
GetBidsInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/bids/recommendations
Рекомендованные ставки для заданных товаров (getBidsRecommendations)
Возвращает рекомендованные ставки для заданных товаров — такие ставки обеспечивают вашим предложениям определенную долю показов, если цена не превышает рекомендованную.
Для одного товара может возвращаться одна рекомендованная ставка или несколько. Во втором случае разные ставки предназначены для достижения разной доли показов.
Если товар только добавлен в каталог, но пока не продается, рекомендованной ставки для него не будет.
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"recommendations" : [ {
"bidRecommendations" : [ {
"showPercent" : 8,
"bid" : 570
}, {
"showPercent" : 8,
"bid" : 570
} ],
"priceRecommendations" : [ {
"campaignId" : 6,
"price" : 1.1465812980502945
}, {
"campaignId" : 6,
"price" : 1.1465812980502945
} ],
"sku" : "sku",
"bid" : 570
}, {
"bidRecommendations" : [ {
"showPercent" : 8,
"bid" : 570
}, {
"showPercent" : 8,
"bid" : 570
} ],
"priceRecommendations" : [ {
"campaignId" : 6,
"price" : 1.1465812980502945
}, {
"campaignId" : 6,
"price" : 1.1465812980502945
} ],
"sku" : "sku",
"bid" : 570
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Рекомендованные ставки для заданных товаров.
GetBidsRecommendationsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/price-quarantine
Список товаров, находящихся в карантине по цене в кабинете (getBusinessQuarantineOffers)
Возвращает список товаров, которые находятся в карантине по основной цене. Основная цена задается в каталоге и действует во всех магазинах кабинета.
Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST businesses/{businessId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST businesses/{businessId}/offer-prices/updates.
{% note info "𝓠 Что такое карантин?" %}
𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее
{% endnote %}
В запросе можно использовать фильтры.
Результаты возвращаются постранично.
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
}, {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров в карантине.
GetQuarantineOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/settings
Настройки кабинета (getBusinessSettings)
Возвращает информацию о настройках кабинета, идентификатор которого указан в запросе.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Return type
Example data
Content-Type: application/json
{
"result" : {
"settings" : {
"currency" : "RUR",
"onlyDefaultPrice" : true
},
"info" : {
"name" : "name",
"id" : 0
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Настройки кабинета.
GetBusinessSettingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}
Информация о магазине (getCampaign)
Возвращает информацию о магазине.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"campaign" : {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о магазине.
GetCampaignResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/logins
Логины, связанные с магазином (getCampaignLogins)
Возвращает список логинов, у которых есть доступ к магазину.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"logins" : [ "logins", "logins" ]
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список логинов, связанных с магазином.
GetCampaignLoginsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers
Информация о товарах, которые размещены в заданном магазине (getCampaignOffers)
Возвращает список товаров, которые размещены в заданном магазине. Для каждого товара указываются параметры размещения.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"campaignPrice" : {
"vat" : 5,
"discountBase" : 5.962133916683182,
"currencyId" : "RUR",
"value" : 1.4658129805029452,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"available" : true,
"offerId" : "offerId",
"quantum" : {
"minQuantity" : 1,
"stepQuantity" : 60
},
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"status" : "PUBLISHED"
}, {
"campaignPrice" : {
"vat" : 5,
"discountBase" : 5.962133916683182,
"currencyId" : "RUR",
"value" : 1.4658129805029452,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"available" : true,
"offerId" : "offerId",
"quantum" : {
"minQuantity" : 1,
"stepQuantity" : 60
},
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"status" : "PUBLISHED"
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров, размещенных в заданном магазине.
GetCampaignOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/price-quarantine
Список товаров, находящихся в карантине по цене в магазине (getCampaignQuarantineOffers)
Возвращает список товаров, которые находятся в карантине по цене, установленной в заданном магазине.
Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST campaigns/{campaignId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST campaigns/{campaignId}/offer-prices/updates.
{% note info "𝓠 Что такое карантин?" %}
𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее
{% endnote %}
В запросе можно использовать фильтры.
Результаты возвращаются постранично.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
}, {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров в карантине.
GetQuarantineOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/region
Регион магазина (getCampaignRegion)
{% note warning "" %}
Этот метод устарел. Вместо него используйте GET campaigns/{campaignId}/settings.
{% endnote %}
Возвращает регион, в котором находится магазин.
|⚙️ Лимит: 5 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Возвращает регион, в котором находится магазин.
|⚙️ Лимит: 1000 запросов в час|
|-|
GetCampaignRegionResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/settings
Настройки магазина (getCampaignSettings)
Возвращает информацию о настройках магазина, идентификатор которого указан в запросе.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"settings" : {
"showInPremium" : true,
"showInContext" : true,
"localRegion" : {
"delivery" : {
"schedule" : {
"customWorkingDays" : [ "23-09-2022", "23-09-2022" ],
"period" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022"
},
"customHolidays" : [ "23-09-2022", "23-09-2022" ],
"weeklyHolidays" : [ 1, 1 ],
"availableOnHolidays" : true,
"totalHolidays" : [ "23-09-2022", "23-09-2022" ]
}
},
"name" : "name",
"id" : 6,
"type" : "OTHER",
"deliveryOptionsSource" : "WEB"
},
"countryRegion" : 0,
"shopName" : "shopName",
"useOpenStat" : true
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Настройки магазина.
GetCampaignSettingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Список магазинов пользователя (getCampaigns)
Возвращает список магазинов, к которым имеет доступ пользователь — владелец авторизационного токена, использованного в запросе. Для агентских пользователей список состоит из подагентских магазинов.
|⚙️ Лимит: 1000 запросов в час|
|-|
Query parameters
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"campaigns" : [ {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
}, {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
} ],
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Магазины пользователя.
GetCampaignsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/by_login/{login}
Магазины, доступные логину (getCampaignsByLogin)
Возвращает список магазинов, к которым у пользователя с указанным логином есть доступ.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
login (required)
Path Parameter — Логин пользователя. default: null
Query parameters
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"campaigns" : [ {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
}, {
"clientId" : 6,
"business" : {
"name" : "name",
"id" : 0
},
"domain" : "domain",
"placementType" : "FBS",
"id" : 0
} ],
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о магазинах.
GetCampaignsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /categories/max-sale-quantum
Лимит на установку кванта продажи и минимального количества товаров в заказе (getCategoriesMaxSaleQuantum)
Возвращает лимит на установку кванта и минимального количества товаров в заказе, которые вы можете задать для товаров указанных категорий.
Если вы передадите значение кванта или минимального количества товаров выше установленного Маркетом ограничения, товар будет скрыт с витрины.
Подробнее о том, как продавать товары по несколько штук, читайте в Справке Маркета для продавцов.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"results" : [ {
"maxSaleQuantum" : 6,
"name" : "name",
"id" : 0
}, {
"maxSaleQuantum" : 6,
"name" : "name",
"id" : 0
} ],
"errors" : [ {
"type" : "UNKNOWN_CATEGORY",
"categoryId" : 1
}, {
"type" : "UNKNOWN_CATEGORY",
"categoryId" : 1
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Лимит на установку кванта и минимального количества товаров.
GetCategoriesMaxSaleQuantumResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Дерево категорий (getCategoriesTree)
Возвращает дерево категорий Маркета.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Категории Маркета.
GetCategoriesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /category/{categoryId}/parameters
Списки характеристик товаров по категориям (getCategoryContentParameters)
Возвращает список характеристик с допустимыми значениями для заданной категории.
|⚙️ Лимит: 50 категорий в минуту |
|-|
Path parameters
categoryId (required)
Path Parameter —
Идентификатор категории на Маркете.
Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом POST categories/tree.
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"parameters" : [ {
"values" : [ {
"description" : "description",
"id" : 5,
"value" : "value"
}, {
"description" : "description",
"id" : 5,
"value" : "value"
} ],
"recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
"description" : "description",
"type" : "TEXT",
"constraints" : {
"minValue" : 2.3021358869347655,
"maxValue" : 7.061401241503109,
"maxLength" : 9
},
"required" : true,
"multivalue" : true,
"unit" : {
"defaultUnitId" : 1,
"units" : [ {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
}, {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
} ]
},
"valueRestrictions" : [ {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
}, {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
} ],
"distinctive" : true,
"name" : "name",
"id" : 6,
"filtering" : true,
"allowCustomValues" : true
}, {
"values" : [ {
"description" : "description",
"id" : 5,
"value" : "value"
}, {
"description" : "description",
"id" : 5,
"value" : "value"
} ],
"recommendationTypes" : [ "HAS_VIDEO", "HAS_VIDEO" ],
"description" : "description",
"type" : "TEXT",
"constraints" : {
"minValue" : 2.3021358869347655,
"maxValue" : 7.061401241503109,
"maxLength" : 9
},
"required" : true,
"multivalue" : true,
"unit" : {
"defaultUnitId" : 1,
"units" : [ {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
}, {
"name" : "кг",
"fullName" : "килограмм",
"id" : 5
} ]
},
"valueRestrictions" : [ {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
}, {
"limitedValues" : [ {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
}, {
"limitingOptionValueId" : 2,
"optionValueIds" : [ 4, 4 ]
} ],
"limitingParameterId" : 3
} ],
"distinctive" : true,
"name" : "name",
"id" : 6,
"filtering" : true,
"allowCustomValues" : true
} ],
"categoryId" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список характеристик товаров из заданной категории.
GetCategoryContentParametersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/history
Получение истории сообщений в чате (getChatHistory)
Возвращает историю сообщений в чате с покупателем.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"orderId" : 0,
"messages" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"sender" : "PARTNER",
"payload" : [ {
"size" : 1,
"name" : "name",
"url" : "url"
}, {
"size" : 1,
"name" : "name",
"url" : "url"
} ],
"messageId" : 6,
"message" : "message"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"sender" : "PARTNER",
"payload" : [ {
"size" : 1,
"name" : "name",
"url" : "url"
}, {
"size" : 1,
"name" : "name",
"url" : "url"
} ],
"messageId" : 6,
"message" : "message"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
История сообщений успешно получена.
GetChatHistoryResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats
Получение доступных чатов (getChats)
Возвращает ваши чаты с покупателями.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"chats" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"chatId" : 0,
"orderId" : 6,
"type" : "CHAT",
"status" : "NEW",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"chatId" : 0,
"orderId" : 6,
"type" : "CHAT",
"status" : "NEW",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список чатов.
GetChatsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feeds/{feedId}
Информация о прайс-листе (getFeed)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает информацию о прайс-листе, размещенном на Маркете для заданного магазина. Также ресурс возвращает результаты автоматических проверок прайс-листа.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"feed" : {
"password" : "password",
"download" : {
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 5
}
},
"uploadDate" : "2000-01-23T04:56:07.000+00:00",
"publication" : {
"priceAndStockUpdate" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
},
"full" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
}
},
"name" : "name",
"id" : 0,
"placement" : {
"totalOffersCount" : 5
},
"login" : "login",
"url" : "url",
"content" : {
"rejectedOffersCount" : 6,
"error" : {
"type" : "PARSE_ERROR"
},
"status" : "ERROR",
"totalOffersCount" : 1
}
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о прайс-листе.
GetFeedResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feeds/{feedId}/index-logs
Отчет по индексации прайс-листа (getFeedIndexLogs)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает отчет по индексации прайс-листа для заданного магазина. Отчет позволяет получить статистику загрузки прайс-листа и результаты его автоматических проверок.
Данные в отчете возвращаются в порядке убывания значений параметра generationId.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Query parameters
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
published_time_from (optional)
Query Parameter —
Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
Значение по умолчанию: последние восемь дней со времени отправки запроса.
default: null format: date-time
published_time_to (optional)
Query Parameter —
Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-31T00:42:42+03:00.
Значение по умолчанию: дата и время отправки запроса.
{% note info %}
Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра published_time_to. Значение параметра не должно быть датой из будущего.
{% endnote %}
default: null format: date-time
status (optional)
Query Parameter —
Статус индексации и проверки прайс-листа на соответствие техническим требованиям.
Возможные значения:
ERROR — произошли ошибки.OK — обработан без ошибок.WARNING — наблюдались некритичные проблемы.
default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"feed" : {
"id" : 0
},
"total" : 2,
"indexLogRecords" : [ {
"offers" : {
"rejectedCount" : 5,
"totalCount" : 5
},
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"generationId" : 6,
"indexType" : "DIFF",
"publishedTime" : "2000-01-23T04:56:07.000+00:00",
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 1
},
"downloadTime" : "2000-01-23T04:56:07.000+00:00",
"status" : "ERROR"
}, {
"offers" : {
"rejectedCount" : 5,
"totalCount" : 5
},
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"generationId" : 6,
"indexType" : "DIFF",
"publishedTime" : "2000-01-23T04:56:07.000+00:00",
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 1
},
"downloadTime" : "2000-01-23T04:56:07.000+00:00",
"status" : "ERROR"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Отчет по индексации прайс-листа.
GetFeedIndexLogsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feedback/updates
Новые и обновленные отзывы о магазине (getFeedbackAndCommentUpdates)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает новые и обновленные отзывы о магазине на Маркете.
Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Выходные данные содержат идентификатор следующей страницы.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
from_date (optional)
Query Parameter —
Начальная дата обновления отзывов.
Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.
Формат даты: ГГГГ-ММ-ДД.
default: null format: date
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
},
"feedbackList" : [ {
"comments" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"shop" : {
"name" : "name"
},
"author" : {
"name" : "name",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}
},
"verified" : true,
"recommend" : true,
"grades" : {
"average" : 5.962133916683182,
"agreeCount" : 5,
"rejectCount" : 2,
"factors" : [ {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
}, {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
} ]
},
"pro" : "pro",
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"text" : "text",
"state" : "LAST",
"contra" : "contra",
"resolved" : true,
"order" : {
"delivery" : "DELIVERY",
"shopOrderId" : "shopOrderId"
}
}, {
"comments" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"shop" : {
"name" : "name"
},
"author" : {
"name" : "name",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}
},
"verified" : true,
"recommend" : true,
"grades" : {
"average" : 5.962133916683182,
"agreeCount" : 5,
"rejectCount" : 2,
"factors" : [ {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
}, {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
} ]
},
"pro" : "pro",
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"text" : "text",
"state" : "LAST",
"contra" : "contra",
"resolved" : true,
"order" : {
"delivery" : "DELIVERY",
"shopOrderId" : "shopOrderId"
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список отзывов для магазина.
GetFeedbackListResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feeds
Список прайс-листов магазина (getFeeds)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает список прайс-листов, размещенных на Маркете для магазина. Также ресурс возвращает результаты автоматических проверок прайс-листов.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"feeds" : [ {
"password" : "password",
"download" : {
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 5
}
},
"uploadDate" : "2000-01-23T04:56:07.000+00:00",
"publication" : {
"priceAndStockUpdate" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
},
"full" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
}
},
"name" : "name",
"id" : 0,
"placement" : {
"totalOffersCount" : 5
},
"login" : "login",
"url" : "url",
"content" : {
"rejectedOffersCount" : 6,
"error" : {
"type" : "PARSE_ERROR"
},
"status" : "ERROR",
"totalOffersCount" : 1
}
}, {
"password" : "password",
"download" : {
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 5
}
},
"uploadDate" : "2000-01-23T04:56:07.000+00:00",
"publication" : {
"priceAndStockUpdate" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
},
"full" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
}
},
"name" : "name",
"id" : 0,
"placement" : {
"totalOffersCount" : 5
},
"login" : "login",
"url" : "url",
"content" : {
"rejectedOffersCount" : 6,
"error" : {
"type" : "PARSE_ERROR"
},
"status" : "ERROR",
"totalOffersCount" : 1
}
} ]
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список прайс-листов.
GetFeedsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Идентификаторы складов Маркета (FBY) (getFulfillmentWarehouses)
Возвращает список складов Маркета с их идентификаторами.
|⚙️ Лимит: 100 запросов в минуту|
|-|
Return type
Example data
Content-Type: application/json
{
"result" : {
"warehouses" : [ {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"name" : "name",
"id" : 0
}, {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"name" : "name",
"id" : 0
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список складов.
GetFulfillmentWarehousesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/comments
Получение комментариев к отзыву (getGoodsFeedbackComments)
Возвращает комментарии к отзыву.
Результаты возвращаются постранично, одна страница содержит не более 20 комментариев.
Комментарии расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"comments" : [ {
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 0,
"text" : "text",
"canModify" : true,
"parentId" : 6,
"status" : "PUBLISHED"
}, {
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 0,
"text" : "text",
"canModify" : true,
"parentId" : 6,
"status" : "PUBLISHED"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Дерево комментариев к отзыву.
GetGoodsFeedbackCommentsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback
Получение отзывов о товарах продавца (getGoodsFeedbacks)
Возвращает все отзывы о товарах продавца по указанным фильтрам.
Результаты возвращаются постранично, одна страница содержит не более 20 отзывов.
Отзывы расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"feedbacks" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"needReaction" : true,
"identifiers" : {
"orderId" : 6,
"modelId" : 1
},
"author" : "author",
"feedbackId" : 0,
"description" : {
"advantages" : "advantages",
"disadvantages" : "disadvantages",
"comment" : "comment"
},
"media" : {
"videos" : [ "videos", "videos" ],
"photos" : [ "photos", "photos" ]
},
"statistics" : {
"commentsCount" : 5,
"rating" : 3,
"paidAmount" : 2,
"recommended" : true
}
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"needReaction" : true,
"identifiers" : {
"orderId" : 6,
"modelId" : 1
},
"author" : "author",
"feedbackId" : 0,
"description" : {
"advantages" : "advantages",
"disadvantages" : "disadvantages",
"comment" : "comment"
},
"media" : {
"videos" : [ "videos", "videos" ],
"photos" : [ "photos", "photos" ]
},
"statistics" : {
"commentsCount" : 5,
"rating" : 3,
"paidAmount" : 2,
"recommended" : true
}
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список отзывов.
GetGoodsFeedbackResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/stats/skus
Отчет по товарам (getGoodsStats)
Возвращает подробный отчет по товарам, которые вы разместили на Маркете. С помощью отчета вы можете узнать, например, об остатках на складе, об условиях хранения ваших товаров и т. д.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"shopSkus" : [ {
"shopSku" : "shopSku",
"marketSku" : 0,
"price" : 6.027456183070403,
"name" : "name",
"warehouses" : [ {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
}, {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
} ],
"weightDimensions" : {
"length" : 5.962133916683182,
"width" : 5.637376656633329,
"weight" : 7.061401241503109,
"height" : 2.3021358869347655
},
"categoryName" : "categoryName",
"categoryId" : 1,
"pictures" : [ "pictures", "pictures" ],
"tariffs" : [ {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
}, {
"shopSku" : "shopSku",
"marketSku" : 0,
"price" : 6.027456183070403,
"name" : "name",
"warehouses" : [ {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
}, {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
} ],
"weightDimensions" : {
"length" : 5.962133916683182,
"width" : 5.637376656633329,
"weight" : 7.061401241503109,
"height" : 2.3021358869347655
},
"categoryName" : "categoryName",
"categoryId" : 1,
"pictures" : [ "pictures", "pictures" ],
"tariffs" : [ {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Отчет по товарам.
GetGoodsStatsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/hidden-offers
Информация о скрытых вами товарах (getHiddenOffers)
Возвращает список скрытых вами товаров для заданного магазина.
В списке будут товары, скрытые любым способом — по API, с помощью YML-фида, в кабинете и так далее.
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
offer_id (optional)
Query Parameter — Идентификатор скрытого предложения. default: null
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
offset (optional)
Query Parameter —
Позиция в списке, начиная с которой возвращаются результаты ответа.
Используется вместе с параметром limit.
Если задан offset, параметры page_number и page_size игнорируются.
offset игнорируется, если задан page_token.
default: null format: int32
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"hiddenOffers" : [ {
"offerId" : "offerId"
}, {
"offerId" : "offerId"
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о скрытых вами товарах.
GetHiddenOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-cards
Получение информации о заполненности карточек магазина (getOfferCardsContentStatus)
Возвращает сведения о состоянии контента для заданных товаров:
- создана ли карточка товара и в каком она статусе;
- заполненность карточки в процентах;
- переданные характеристики товаров;
- есть ли ошибки или предупреждения, связанные с контентом;
- рекомендации по заполнению карточки.
|⚙️ Лимит: 600 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offerCards" : [ {
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"offerId" : "offerId",
"contentRating" : 0,
"recommendations" : [ {
"type" : "HAS_VIDEO",
"percent" : 60
}, {
"type" : "HAS_VIDEO",
"percent" : 60
} ],
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"parameterValues" : [ {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
}, {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
} ]
}, {
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"offerId" : "offerId",
"contentRating" : 0,
"recommendations" : [ {
"type" : "HAS_VIDEO",
"percent" : 60
}, {
"type" : "HAS_VIDEO",
"percent" : 60
} ],
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"parameterValues" : [ {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
}, {
"valueId" : 5,
"parameterId" : 1,
"unitId" : 5,
"value" : "value"
} ]
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о карточках указанных товаров.
GetOfferCardsContentStatusResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offer-mapping-entries
Список товаров в каталоге (getOfferMappingEntries)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings.
{% endnote %}
Для каждого товара, который вы размещаете на Маркете, возвращается информация о карточках Маркета, к которым привязан этот товар:
- Идентификатор текущей карточки (marketSku), карточки, которая проходит модерацию и последней отклоненной карточки.
- Описание товара, которое указано на карточке Маркета. Например, размер упаковки и вес товара.
Результаты возвращаются постранично. Выходные данные содержат идентификатор следующей страницы.
{% note info %}
Количество товаров в каталоге магазина считается по данным за последние семь дней (не включая сегодня).
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
offer_id (optional)
Query Parameter — Идентификатор товара в каталоге. default: null
shop_sku (optional)
Query Parameter —
Ваш SKU товара.
Параметр может быть указан несколько раз, например:
...shop_sku=123&shop_sku=129&shop_sku=141...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
mapping_kind (optional)
Query Parameter — Тип маппинга. default: null
status (optional)
Query Parameter —
Фильтрация по статусу публикации товара:
READY — товар прошел модерацию.IN_WORK — товар проходит модерацию.NEED_CONTENT — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.NEED_INFO — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.REJECTED — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.SUSPENDED — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.OTHER — товар не прошел модерацию по другой причине.
Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
availability (optional)
Query Parameter —
Фильтрация по планам поставок товара:
ACTIVE — поставки будут.INACTIVE — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.DELISTED — архив: товар закончился на складе, и его поставок больше не будет.
Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
category_id (optional)
Query Parameter —
Фильтрация по идентификатору категории на Маркете.
Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом POST categories/tree.
Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
vendor (optional)
Query Parameter —
Фильтрация по бренду товара.
Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.
Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе Кодирование URL русскоязычной Википедии.
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offerMappingEntries" : [ {
"offer" : {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
},
"mapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"awaitingModerationMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"rejectedMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
}
}, {
"offer" : {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
},
"mapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"awaitingModerationMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"rejectedMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
}
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о товарах в каталоге.
GetOfferMappingEntriesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings
Информация о товарах в каталоге (getOfferMappings)
Возвращает список товаров в каталоге, их категории на Маркете и характеристики каждого товара.
Можно использовать тремя способами:
- задать список интересующих SKU;
- задать фильтр — в этом случае результаты возвращаются постранично;
- не передавать тело запроса, чтобы получить список всех товаров в каталоге.
|⚙️ Лимит: 600 запросов в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
},
"offerMappings" : [ {
"offer" : {
"downloadable" : true,
"sellingPrograms" : [ {
"sellingProgram" : "FBY",
"status" : "FINE"
}, {
"sellingProgram" : "FBY",
"status" : "FINE"
} ],
"marketCategoryId" : 0,
"manufacturerCountries" : [ "Россия", "Россия" ],
"description" : "description",
"videos" : [ "videos", "videos", "videos", "videos", "videos" ],
"purchasePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"type" : "DEFAULT",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"archived" : true,
"campaigns" : [ {
"campaignId" : 9,
"status" : "PUBLISHED"
}, {
"campaignId" : 9,
"status" : "PUBLISHED"
} ],
"vendor" : "LEVENHUK",
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"barcodes" : [ "46012300000000", "46012300000000" ],
"params" : [ {
"name" : "Wi-Fi",
"value" : "есть"
}, {
"name" : "Wi-Fi",
"value" : "есть"
} ],
"tags" : [ "до 500 рублей", "до 500 рублей" ],
"condition" : {
"reason" : "reason",
"type" : "PREOWNED",
"quality" : "PERFECT"
},
"certificates" : [ "certificates", "certificates" ],
"boxCount" : 1,
"additionalExpenses" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"customsCommodityCode" : "8517610008",
"adult" : true,
"age" : {
"ageUnit" : "YEAR",
"value" : 0.5962133916683182
},
"manuals" : [ {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
} ]
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
}, {
"offer" : {
"downloadable" : true,
"sellingPrograms" : [ {
"sellingProgram" : "FBY",
"status" : "FINE"
}, {
"sellingProgram" : "FBY",
"status" : "FINE"
} ],
"marketCategoryId" : 0,
"manufacturerCountries" : [ "Россия", "Россия" ],
"description" : "description",
"videos" : [ "videos", "videos", "videos", "videos", "videos" ],
"purchasePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"type" : "DEFAULT",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"archived" : true,
"campaigns" : [ {
"campaignId" : 9,
"status" : "PUBLISHED"
}, {
"campaignId" : 9,
"status" : "PUBLISHED"
} ],
"vendor" : "LEVENHUK",
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"cardStatus" : "HAS_CARD_CAN_NOT_UPDATE",
"barcodes" : [ "46012300000000", "46012300000000" ],
"params" : [ {
"name" : "Wi-Fi",
"value" : "есть"
}, {
"name" : "Wi-Fi",
"value" : "есть"
} ],
"tags" : [ "до 500 рублей", "до 500 рублей" ],
"condition" : {
"reason" : "reason",
"type" : "PREOWNED",
"quality" : "PERFECT"
},
"certificates" : [ "certificates", "certificates" ],
"boxCount" : 1,
"additionalExpenses" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"customsCommodityCode" : "8517610008",
"adult" : true,
"age" : {
"ageUnit" : "YEAR",
"value" : 0.5962133916683182
},
"manuals" : [ {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
}, {
"title" : "title",
"url" : "url"
} ]
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о товарах в каталоге.
GetOfferMappingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offers/recommendations
Рекомендации Маркета, касающиеся цен (getOfferRecommendations)
Метод возвращает рекомендации нескольких типов.
1. Порог для привлекательной цены. Он нужен для участия в софинансировании скидок.
Показывает, какие цены для участия нужно установить, чтобы получить максимальные шансы на срабатывание скидок, софинансируемых Маркетом. Как это устроено
2. Оценка привлекательности цен на витрине.
Привлекательность влияет на вероятность срабатывания скидок за счет Маркета. Как это устроено
В запросе можно использовать фильтры.
Результаты возвращаются постранично.
|⚙️ Лимит: 100 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
},
"offerRecommendations" : [ {
"offer" : {
"shows" : 0,
"price" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitiveness" : "OPTIMAL",
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}
},
"recommendation" : {
"recommendedCofinancePrice" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitivenessThresholds" : {
"optimalPrice" : {
"value" : 0.9301444243932576
},
"averagePrice" : {
"value" : 0.9301444243932576
}
}
}
}, {
"offer" : {
"shows" : 0,
"price" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitiveness" : "OPTIMAL",
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}
},
"recommendation" : {
"recommendedCofinancePrice" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitivenessThresholds" : {
"optimalPrice" : {
"value" : 0.9301444243932576
},
"averagePrice" : {
"value" : 0.9301444243932576
}
}
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров с рекомендациями.
GetOfferRecommendationsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offers
Предложения магазина (getOffers)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет фильтровать информацию о предложениях магазина, размещенных на Маркете, и искать предложения по заданному поисковому запросу.
Поиск предложений, размещенных на Маркете, работает по поисковому запросу аналогично поиску Маркета. Результаты возвращаются с использованием пейджера.
В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Маркета, с которой соотнесено предложение, и аукционные ставки на него.
{% note info %}
Из-за особенностей поиска Маркета иногда на последних страницах пейджера фактическое количество результатов оказывается меньше количества, указанного ранее на предыдущих страницах.
В связи с этим настоятельно рекомендуется анализировать содержимое параметра pager для каждой полученной страницы.
{% endnote %}
{% note info %}
Количество предложений считается по данным за последние семь дней (не включая сегодня).
Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
query (optional)
Query Parameter —
Поисковый запрос.
Поддерживается язык запросов.
Значение по умолчанию: все предложения магазина, размещенные на Маркете.
default: null
feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
shopCategoryId (optional)
Query Parameter —
Идентификатор категории предложения, указанный магазином в прайс-листе.
Параметр выводится только для предложений, у которых указана категория в прайс-листе.
Параметр доступен начиная с версии 2.0 партнерского API.
default: null
currency (optional)
Query Parameter —
Валюта, в которой указана цена предложения.
Возможные значения:
default: null
matched (optional)
Query Parameter —
Фильтр по признаку соотнесения предложения и карточки модели.
Возможные значения:
-
0 / FALSE / NO — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.
-
1 / TRUE / YES — поиск выполняется среди предложений, соотнесенных с карточками моделей).
default: null
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"offers" : [ {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
}, {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
} ],
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Предложения магазина.
GetOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}
Информация об одном заказе (getOrder)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"order" : {
"delivery" : {
"dispatchType" : "UNKNOWN",
"address" : {
"country" : "country",
"city" : "city",
"postcode" : "postcode",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"house" : "house",
"subway" : "subway",
"phone" : "phone",
"street" : "street",
"district" : "district",
"recipient" : "recipient",
"entryphone" : "entryphone",
"block" : "block",
"entrance" : "entrance",
"floor" : "floor",
"apartment" : "apartment"
},
"liftType" : "NOT_NEEDED",
"deliveryServiceId" : 6,
"estimated" : true,
"dates" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022",
"fromTime" : "fromTime",
"toTime" : "toTime",
"realDeliveryDate" : "23-09-2022"
},
"type" : "DELIVERY",
"serviceName" : "serviceName",
"shipments" : [ {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
}, {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
} ],
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ],
"courier" : {
"vehicleDescription" : "vehicleDescription",
"phone" : "phone",
"phoneExtension" : "phoneExtension",
"fullName" : "fullName",
"vehicleNumber" : "vehicleNumber"
},
"price" : 5.025004791520295,
"outletStorageLimitDate" : "23-09-2022",
"eacType" : "MERCHANT_TO_COURIER",
"liftPrice" : 8.762042012749001,
"eacCode" : "eacCode",
"id" : "id",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"deliveryPartnerType" : "SHOP",
"outletCode" : "outletCode"
},
"notes" : "notes",
"substatus" : "RESERVATION_EXPIRED",
"deliveryTotal" : 1.4658129805029452,
"buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
"creationDate" : "23-09-2022 09:12:41",
"buyerItemsTotal" : 5.962133916683182,
"paymentType" : "PREPAID",
"buyer" : {
"lastName" : "lastName",
"firstName" : "firstName",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"expiryDate" : "23-09-2022 09:12:41",
"buyerTotalBeforeDiscount" : 7.061401241503109,
"itemsTotal" : 6.027456183070403,
"buyerTotal" : 5.637376656633329,
"subsidies" : [ {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
} ],
"paymentMethod" : "CASH_ON_DELIVERY",
"currency" : "RUR",
"fake" : true,
"id" : 0,
"taxSystem" : "OSN",
"cancelRequested" : true,
"items" : [ {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
}, {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
} ],
"status" : "PLACING",
"updatedAt" : "23-09-2022 09:12:41"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о заказе.
GetOrderResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/{orderId}/business-buyer
Информация о покупателе — юридическом лице (getOrderBusinessBuyerInfo)
Возвращает информацию о покупателе по идентификатору заказа.
{% note info "" %}
Чтобы получить информацию о покупателе, который является физическим лицом, воспользуйтесь запросом GET campaigns/{campaignId}/orders/{orderId}/buyer.
{% endnote %}
Получить данные можно, только если заказ находится в статусе PROCESSING, DELIVERY, PICKUP или DELIVERED.
Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.
|⚙️ Лимит: 3 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"organizationName" : "organizationName",
"organizationJurAddress" : "organizationJurAddress",
"inn" : "inn",
"kpp" : "kpp"
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о покупателе.
GetBusinessBuyerInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/{orderId}/documents
Информация о документах (getOrderBusinessDocumentsInfo)
Возвращает информацию о документах по идентификатору заказа.
Получить данные можно после того, как заказ перейдет в статус DELIVERED.
Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.
|⚙️ Лимит: 3 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"sf" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"torgTwelve" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"upd" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"ukd" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"ksf" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о документах.
GetBusinessDocumentsInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders
Информация о нескольких заказах (getOrders)
Возвращает информацию о заказах. Запрос можно использовать, чтобы узнать, нет ли новых заказов.
Доступна фильтрация по нескольким характеристикам заказов:
-
дате оформления;
-
статусу;
-
идентификаторам заказов;
-
этапу обработки или причине отмены;
-
типу (настоящий или тестовый);
-
дате отгрузки в службу доставки;
-
дате и времени обновления заказа.
Информация о заказах, доставленных или отмененных больше 30 дней назад, не возвращается. Ее можно получить с помощью запроса информации об отдельном заказе GET campaigns/{campaignId}/orders/{orderId} (если у вас есть идентификатор заказа) или запроса отчета по заказам POST campaigns/{campaignId}/stats/orders.
Максимальный диапазон дат за один запрос к ресурсу — 30 дней. Максимальное количество заказов в выходных данных запроса — 50.
Результаты возвращаются постранично. Для навигации по страницам используйте параметры page_token и limit.
Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса GET campaigns/{campaignId}/orders/{orderId}/buyer.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
orderIds (optional)
Query Parameter — Фильтрация заказов по идентификаторам.
⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. default: null format: int64
status (optional)
Query Parameter —
Статус заказа:
-
CANCELLED — заказ отменен.
-
DELIVERED — заказ получен покупателем.
-
DELIVERY — заказ передан в службу доставки.
-
PICKUP — заказ доставлен в пункт самовывоза.
-
PROCESSING — заказ находится в обработке.
-
UNPAID — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении).
Также могут возвращаться другие значения. Обрабатывать их не требуется.
default: null
substatus (optional)
Query Parameter —
Этап обработки заказа (если он имеет статус PROCESSING) или причина отмены заказа (если он имеет статус CANCELLED).
Возможные значения для заказа в статусе PROCESSING:
STARTED — заказ подтвержден, его можно начать обрабатывать.READY_TO_SHIP — заказ собран и готов к отправке.SHIPPED — заказ передан службе доставки.
Возможные значения для заказа в статусе CANCELLED:
-
DELIVERY_SERVICE_UNDELIVERED — служба доставки не смогла доставить заказ.
-
PROCESSING_EXPIRED — значение более не используется.
-
REPLACING_ORDER — покупатель решил заменить товар другим по собственной инициативе.
-
RESERVATION_EXPIRED — покупатель не завершил оформление зарезервированного заказа в течение 10 минут.
-
RESERVATION_FAILED — Маркет не может продолжить дальнейшую обработку заказа.
-
SHOP_FAILED — магазин не может выполнить заказ.
-
USER_CHANGED_MIND — покупатель отменил заказ по личным причинам.
-
USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут.
-
USER_REFUSED_DELIVERY — покупателя не устроили условия доставки.
-
USER_REFUSED_PRODUCT — покупателю не подошел товар.
-
USER_REFUSED_QUALITY — покупателя не устроило качество товара.
-
USER_UNREACHABLE — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:
- не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
- перерыв между первым и третьим звонком не менее 90 минут;
- соединение не короче 5 секунд.
Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.
-
USER_WANTS_TO_CHANGE_DELIVERY_DATE — покупатель хочет получить заказ в другой день.
-
CANCELLED_COURIER_NOT_FOUND — не удалось найти курьера.
Также могут возвращаться другие значения. Обрабатывать их не требуется.
default: null
fromDate (optional)
Query Parameter —
Начальная дата для фильтрации заказов по дате оформления.
Формат даты: ДД-ММ-ГГГГ.
Между начальной и конечной датой (параметр toDate) должно быть не больше 30 дней.
Значение по умолчанию: 30 дней назад от текущей даты.
default: null format: date
toDate (optional)
Query Parameter —
Конечная дата для фильтрации заказов по дате оформления.
Показываются заказы, созданные до 00:00 указанного дня.
Формат даты: ДД-ММ-ГГГГ.
Между начальной (параметр fromDate) и конечной датой должно быть не больше 30 дней.
Значение по умолчанию: текущая дата.
default: null format: date
supplierShipmentDateFrom (optional)
Query Parameter —
Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).
Формат даты: ДД-ММ-ГГГГ.
Между начальной и конечной датой (параметр supplierShipmentDateTo) должно быть не больше 30 дней.
Начальная дата включается в интервал для фильтрации.
default: null format: date
supplierShipmentDateTo (optional)
Query Parameter —
Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).
Формат даты: ДД-ММ-ГГГГ.
Между начальной (параметр supplierShipmentDateFrom) и конечной датой должно быть не больше 30 дней.
Конечная дата не включается в интервал для фильтрации.
default: null format: date
updatedAtFrom (optional)
Query Parameter —
Начальная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
Между начальной и конечной датой (параметр updatedAtTo) должно быть не больше 30 дней.
Начальная дата включается в интервал для фильтрации.
default: null format: date-time
updatedAtTo (optional)
Query Parameter —
Конечная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
Между начальной (параметр updatedAtFrom) и конечной датой должно быть не больше 30 дней.
Конечная дата не включается в интервал для фильтрации.
default: null format: date-time
dispatchType (optional)
Query Parameter — Способ отгрузки default: null
fake (optional)
Query Parameter —
Фильтрация заказов по типам:
default: false
hasCis (optional)
Query Parameter —
Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации в системе «Честный ЗНАК»:
Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.
default: false
onlyWaitingForCancellationApprove (optional)
Query Parameter —
Только для модели DBS
Фильтрация заказов по наличию запросов покупателей на отмену.
При значение true возвращаются только заказы, которые находятся в статусе DELIVERY или PICKUP и которые пользователи решили отменить.
Чтобы подтвердить или отклонить отмену, отправьте запрос PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept.
default: false
onlyEstimatedDelivery (optional)
Query Parameter —
Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки:
true — возвращаются только заказы с неподтвержденной датой доставки.false — фильтрация не применяется.
default: false
buyerType (optional)
Query Parameter — Фильтрация заказов по типу покупателя. default: null
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
},
"orders" : [ {
"delivery" : {
"dispatchType" : "UNKNOWN",
"address" : {
"country" : "country",
"city" : "city",
"postcode" : "postcode",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"house" : "house",
"subway" : "subway",
"phone" : "phone",
"street" : "street",
"district" : "district",
"recipient" : "recipient",
"entryphone" : "entryphone",
"block" : "block",
"entrance" : "entrance",
"floor" : "floor",
"apartment" : "apartment"
},
"liftType" : "NOT_NEEDED",
"deliveryServiceId" : 6,
"estimated" : true,
"dates" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022",
"fromTime" : "fromTime",
"toTime" : "toTime",
"realDeliveryDate" : "23-09-2022"
},
"type" : "DELIVERY",
"serviceName" : "serviceName",
"shipments" : [ {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
}, {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
} ],
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ],
"courier" : {
"vehicleDescription" : "vehicleDescription",
"phone" : "phone",
"phoneExtension" : "phoneExtension",
"fullName" : "fullName",
"vehicleNumber" : "vehicleNumber"
},
"price" : 5.025004791520295,
"outletStorageLimitDate" : "23-09-2022",
"eacType" : "MERCHANT_TO_COURIER",
"liftPrice" : 8.762042012749001,
"eacCode" : "eacCode",
"id" : "id",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"deliveryPartnerType" : "SHOP",
"outletCode" : "outletCode"
},
"notes" : "notes",
"substatus" : "RESERVATION_EXPIRED",
"deliveryTotal" : 1.4658129805029452,
"buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
"creationDate" : "23-09-2022 09:12:41",
"buyerItemsTotal" : 5.962133916683182,
"paymentType" : "PREPAID",
"buyer" : {
"lastName" : "lastName",
"firstName" : "firstName",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"expiryDate" : "23-09-2022 09:12:41",
"buyerTotalBeforeDiscount" : 7.061401241503109,
"itemsTotal" : 6.027456183070403,
"buyerTotal" : 5.637376656633329,
"subsidies" : [ {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
} ],
"paymentMethod" : "CASH_ON_DELIVERY",
"currency" : "RUR",
"fake" : true,
"id" : 0,
"taxSystem" : "OSN",
"cancelRequested" : true,
"items" : [ {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
}, {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
} ],
"status" : "PLACING",
"updatedAt" : "23-09-2022 09:12:41"
}, {
"delivery" : {
"dispatchType" : "UNKNOWN",
"address" : {
"country" : "country",
"city" : "city",
"postcode" : "postcode",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"house" : "house",
"subway" : "subway",
"phone" : "phone",
"street" : "street",
"district" : "district",
"recipient" : "recipient",
"entryphone" : "entryphone",
"block" : "block",
"entrance" : "entrance",
"floor" : "floor",
"apartment" : "apartment"
},
"liftType" : "NOT_NEEDED",
"deliveryServiceId" : 6,
"estimated" : true,
"dates" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022",
"fromTime" : "fromTime",
"toTime" : "toTime",
"realDeliveryDate" : "23-09-2022"
},
"type" : "DELIVERY",
"serviceName" : "serviceName",
"shipments" : [ {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
}, {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
} ],
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ],
"courier" : {
"vehicleDescription" : "vehicleDescription",
"phone" : "phone",
"phoneExtension" : "phoneExtension",
"fullName" : "fullName",
"vehicleNumber" : "vehicleNumber"
},
"price" : 5.025004791520295,
"outletStorageLimitDate" : "23-09-2022",
"eacType" : "MERCHANT_TO_COURIER",
"liftPrice" : 8.762042012749001,
"eacCode" : "eacCode",
"id" : "id",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"deliveryPartnerType" : "SHOP",
"outletCode" : "outletCode"
},
"notes" : "notes",
"substatus" : "RESERVATION_EXPIRED",
"deliveryTotal" : 1.4658129805029452,
"buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
"creationDate" : "23-09-2022 09:12:41",
"buyerItemsTotal" : 5.962133916683182,
"paymentType" : "PREPAID",
"buyer" : {
"lastName" : "lastName",
"firstName" : "firstName",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"expiryDate" : "23-09-2022 09:12:41",
"buyerTotalBeforeDiscount" : 7.061401241503109,
"itemsTotal" : 6.027456183070403,
"buyerTotal" : 5.637376656633329,
"subsidies" : [ {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
} ],
"paymentMethod" : "CASH_ON_DELIVERY",
"currency" : "RUR",
"fake" : true,
"id" : 0,
"taxSystem" : "OSN",
"cancelRequested" : true,
"items" : [ {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
}, {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
} ],
"status" : "PLACING",
"updatedAt" : "23-09-2022 09:12:41"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о заказах.
GetOrdersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/stats/orders
Детальная информация по заказам (getOrdersStats)
Возвращает информацию по заказам на Маркете, в которых есть ваши товары. С помощью нее вы можете собрать статистику по вашим заказам и узнать, например, какие из товаров чаще всего возвращаются покупателями, какие, наоборот, пользуются большим спросом, какая комиссия начисляется за заказы и т. п.
{% note info "" %}
Раньше генерация детальной информации по заказам называлась Отчет по заказам. Сейчас это новый отчет. Подробнее об отчете
{% endnote %}
В одном запросе можно получить информацию не более чем по 200 заказам.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"orders" : [ {
"partnerOrderId" : "partnerOrderId",
"commissions" : [ {
"actual" : 1.2315135367772556,
"type" : "FEE"
}, {
"actual" : 1.2315135367772556,
"type" : "FEE"
} ],
"statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
"payments" : [ {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
}, {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
} ],
"fake" : true,
"deliveryRegion" : {
"name" : "name",
"id" : 6
},
"id" : 0,
"creationDate" : "2000-01-23",
"items" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"initialItems" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"status" : "CANCELLED_BEFORE_PROCESSING",
"paymentType" : "CREDIT"
}, {
"partnerOrderId" : "partnerOrderId",
"commissions" : [ {
"actual" : 1.2315135367772556,
"type" : "FEE"
}, {
"actual" : 1.2315135367772556,
"type" : "FEE"
} ],
"statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
"payments" : [ {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
}, {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
} ],
"fake" : true,
"deliveryRegion" : {
"name" : "name",
"id" : 6
},
"id" : 0,
"creationDate" : "2000-01-23",
"items" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"initialItems" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"status" : "CANCELLED_BEFORE_PROCESSING",
"paymentType" : "CREDIT"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация по заказам.
GetOrdersStatsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offer-prices
Список цен (getPrices)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST campaigns/{campaignId}/offer-prices.
{% endnote %}
Возвращает список цен, установленных вами на товары любым способом: например, через партнерский API или в файле с каталогом.
{% note info %}
Общее количество товаров считается по данным за последние семь дней (не включая сегодня) и не может быть выше 2 миллионов.
{% endnote %}
Способы установки цен описаны в Справке Маркета для продавцов.
|⚙️ Лимит: (количество товаров партнера на витрине) * 25 товаров в сутки|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
archived (optional)
Query Parameter — Фильтр по нахождению в архиве. default: false
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"marketSku" : 0,
"id" : "id",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"marketSku" : 0,
"id" : "id",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"total" : 6,
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список всех товаров с установленными ценами.
GetPricesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-prices
Просмотр цен на указанные товары в магазине (getPricesByOfferIds)
Возвращает список цен на указанные товары в магазине.
{% note warning "Метод только для отдельных магазинов" %}
Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.
Для просмотра базовых цен используйте POST businesses/{businessId}/offer-mappings.
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"offerId" : "offerId",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"offerId" : "offerId",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров с установленными для заданного магазина ценами.
GetPricesByOfferIdsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos/offers
Получение списка товаров, которые участвуют или могут участвовать в акции (getPromoOffers)
Возвращает список товаров, которые участвуют или могут участвовать в акции.
{% note warning %}
В параметре limit не передавайте значение больше 500.
{% endnote %}
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"offerId" : "offerId",
"params" : {
"discountParams" : {
"promoPrice" : 6,
"maxPromoPrice" : 1,
"price" : 0
},
"promocodeParams" : {
"maxPrice" : 5
}
},
"status" : "AUTO",
"autoParticipatingDetails" : {
"campaignIds" : [ 5, 5 ]
}
}, {
"offerId" : "offerId",
"params" : {
"discountParams" : {
"promoPrice" : 6,
"maxPromoPrice" : 1,
"price" : 0
},
"promocodeParams" : {
"maxPrice" : 5
}
},
"status" : "AUTO",
"autoParticipatingDetails" : {
"campaignIds" : [ 5, 5 ]
}
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров, которые участвуют или могут участвовать в акции.
GetPromoOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos
Получение списка акций (getPromos)
Возвращает информацию об акциях Маркета.
По умолчанию возвращаются акции, в которых продавец участвует или может принять участие.
Чтобы получить текущие или завершенные акции, передайте параметр participation.
Типы акций, которые возвращаются в ответе:
- прямая скидка;
- флеш-акция;
- скидка по промокоду.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"promos" : [ {
"period" : {
"dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
"dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
},
"channels" : [ "{}", "{}" ],
"mechanicsInfo" : {
"promocodeInfo" : {
"promocode" : "promocode",
"discount" : 1
},
"type" : "DIRECT_DISCOUNT"
},
"bestsellerInfo" : {
"bestseller" : true,
"entryDeadline" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "name",
"participating" : true,
"id" : "id",
"constraints" : {
"warehouseIds" : [ 5, 5 ]
},
"assortmentInfo" : {
"activeOffers" : 0,
"processing" : true,
"potentialOffers" : 6
}
}, {
"period" : {
"dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
"dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
},
"channels" : [ "{}", "{}" ],
"mechanicsInfo" : {
"promocodeInfo" : {
"promocode" : "promocode",
"discount" : 1
},
"type" : "DIRECT_DISCOUNT"
},
"bestsellerInfo" : {
"bestseller" : true,
"entryDeadline" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "name",
"participating" : true,
"id" : "id",
"constraints" : {
"warehouseIds" : [ 5, 5 ]
},
"assortmentInfo" : {
"activeOffers" : 0,
"processing" : true,
"potentialOffers" : 6
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список акций Маркета.
GetPromosResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/ratings/quality
Индекс качества магазинов (getQualityRatings)
Возвращает значение индекса качества магазинов и его составляющие.
Подробнее об индексе качества читайте в Справке Маркета для продавцов.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"campaignRatings" : [ {
"campaignId" : 0,
"ratings" : [ {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
}, {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
} ]
}, {
"campaignId" : 0,
"ratings" : [ {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
}, {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Значение индекса качества магазинов и его составляющие.
GetQualityRatingResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /reports/info/{reportId}
Получение заданного отчета (getReportInfo)
Возвращает статус генерации заданного отчета и, если отчет готов, ссылку для скачивания.
Чтобы воспользоваться этим запросом, вначале нужно запустить генерацию отчета. Инструкция
|⚙️ Лимит: 100 запросов в минуту|
|-|
Path parameters
reportId (required)
Path Parameter — Идентификатор отчета, который вы получили после запуска генерации. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"generationRequestedAt" : "2000-01-23T04:56:07.000+00:00",
"file" : "file",
"generationFinishedAt" : "2000-01-23T04:56:07.000+00:00",
"subStatus" : "NO_DATA",
"status" : "PENDING",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Статус генерации отчета и ссылка, если она уже есть.
{% note tip %}
Если статус генерации отчета — FAILED или NO_DATA, проверьте корректность запроса на генерацию. Например, верно ли указан идентификатор магазина, период или номер платежного поручения.
{% endnote %}
GetReportInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}
Информация о невыкупе или возврате (getReturn)
Получает информацию по одному невыкупу или возврату.
|⚙️ Лимит: 10 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"updateDate" : "2000-01-23T04:56:07.000+00:00",
"fastReturn" : true,
"orderId" : 6,
"shipmentRecipientType" : "SHOP",
"refundStatus" : "STARTED_BY_USER",
"logisticPickupPoint" : {
"logisticPartnerId" : 5,
"address" : {
"country" : "Россия",
"city" : "Москва",
"street" : "Стрелецкая улица",
"postcode" : "123518",
"house" : "9к2"
},
"instruction" : "instruction",
"name" : "name",
"id" : 1,
"type" : "WAREHOUSE"
},
"id" : 0,
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"items" : [ {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
}, {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
} ],
"returnType" : "UNREDEEMED",
"shipmentStatus" : "CREATED",
"refundAmount" : 5
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Детали возврата.
GetReturnResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}
Получение фотографии возврата (getReturnPhoto)
Получает фотографии, которые покупатель приложил к заявлению на возврат товара.
|⚙️ Лимит: 10 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
itemId (required)
Path Parameter — Идентификатор товара в возврате. default: null format: int64
imageHash (required)
Path Parameter — Хеш ссылки изображения для загрузки. default: null
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/octet-streamapplication/json
Responses
200
Фотография возврата.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/returns
Список невыкупов и возвратов (getReturns)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
orderIds (optional)
Query Parameter —
Идентификаторы заказов — для фильтрации результатов.
Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
default: null format: int64
statuses (optional)
Query Parameter —
Статусы возвратов или невыкупов — для фильтрации результатов.
Несколько статусов перечисляются через запятую.
default: null
type (optional)
Query Parameter —
Тип заказа для фильтрации:
-
RETURN — возврат.
-
UNREDEEMED — невыкуп.
Если не указывать, в ответе будут и возвраты, и невыкупы.
default: null
fromDate (optional)
Query Parameter —
Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
Формат: ГГГГ-ММ-ДД.
default: null format: date
toDate (optional)
Query Parameter —
Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
Формат: ГГГГ-ММ-ДД.
default: null format: date
from_date (optional)
Query Parameter —
{% note warning "" %}
Этот параметр устарел. Вместо него используйте fromDate.
{% endnote %}
Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
default: null format: date
to_date (optional)
Query Parameter —
{% note warning "" %}
Этот параметр устарел. Вместо него используйте toDate.
{% endnote %}
Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
default: null format: date
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"nextPageToken" : "nextPageToken"
},
"returns" : [ {
"updateDate" : "2000-01-23T04:56:07.000+00:00",
"fastReturn" : true,
"orderId" : 6,
"shipmentRecipientType" : "SHOP",
"refundStatus" : "STARTED_BY_USER",
"logisticPickupPoint" : {
"logisticPartnerId" : 5,
"address" : {
"country" : "Россия",
"city" : "Москва",
"street" : "Стрелецкая улица",
"postcode" : "123518",
"house" : "9к2"
},
"instruction" : "instruction",
"name" : "name",
"id" : 1,
"type" : "WAREHOUSE"
},
"id" : 0,
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"items" : [ {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
}, {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
} ],
"returnType" : "UNREDEEMED",
"shipmentStatus" : "CREATED",
"refundAmount" : 5
}, {
"updateDate" : "2000-01-23T04:56:07.000+00:00",
"fastReturn" : true,
"orderId" : 6,
"shipmentRecipientType" : "SHOP",
"refundStatus" : "STARTED_BY_USER",
"logisticPickupPoint" : {
"logisticPartnerId" : 5,
"address" : {
"country" : "Россия",
"city" : "Москва",
"street" : "Стрелецкая улица",
"postcode" : "123518",
"house" : "9к2"
},
"instruction" : "instruction",
"name" : "name",
"id" : 1,
"type" : "WAREHOUSE"
},
"id" : 0,
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"items" : [ {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
}, {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
} ],
"returnType" : "UNREDEEMED",
"shipmentStatus" : "CREATED",
"refundAmount" : 5
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Постраничные возвраты партнера.
GetReturnsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers/stocks
Информация об остатках и оборачиваемости (getStocks)
Возвращает данные об остатках товаров (для всех моделей) и об оборачиваемости товаров (для модели FBY).
{% note info "По умолчанию данные по оборачивамости не возращаются" %}
Чтобы они были в ответе, передавайте true в поле withTurnover.
{% endnote %}
|⚙️ Лимит: 100 000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"warehouses" : [ {
"offers" : [ {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"warehouseId" : 0
}, {
"offers" : [ {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"warehouseId" : 0
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Остатки товаров на складах.
GetWarehouseStocksResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-mapping-entries/suggestions
Рекомендованные карточки для товаров (getSuggestedOfferMappingEntries)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/suggestions.
{% endnote %}
Возвращает идентификаторы карточек товаров на Маркете, рекомендованных для ваших товаров.
Каждому товару, который вы размещаете, должна соответствовать карточка товара на Маркете со своим идентификатором — SKU на Маркете. Он указывается в URL карточки товара, после «...sku=», например:
##https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016…##
Чтобы получить для товаров рекомендованные SKU на Маркете, передайте в теле POST-запроса как можно больше информации о них: названия, производителей, штрихкоды, цены и т. д.
Полученные SKU можно передать вместе с информацией о ваших товарах с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/updates.
В одном запросе можно получить не более 500 рекомендаций.
|⚙️ Лимит: 100 000 рекомендаций в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"marketCategoryId" : 4,
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"marketModelId" : 7,
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"marketSkuName" : "marketSkuName",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"marketModelName" : "marketModelName",
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"marketCategoryName" : "marketCategoryName",
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
}, {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"marketCategoryId" : 4,
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"marketModelId" : 7,
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"marketSkuName" : "marketSkuName",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"marketModelName" : "marketModelName",
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"marketCategoryName" : "marketCategoryName",
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о товарах в каталоге.
GetSuggestedOfferMappingEntriesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/suggestions
Просмотр карточек на Маркете, которые подходят вашим товарам (getSuggestedOfferMappings)
Возвращает идентификаторы карточек на Маркете, которые соответствуют товарам с заданными параметрами.
Пользоваться этим запросом необязательно: он просто помогает заранее убедиться, что Маркет верно определяет карточки по предоставленным вами данным.
Как пользоваться запросом
- Передайте Маркету список товаров, которые нужно проверить.
- В ответ вы получите список SKU на Маркете с расшифровкой: названием, идентификатором модели, категорией.
- Если расшифровки мало, вы можете открыть карточку. Для этого перейдите по ссылке вида
https://market.yandex.ru/product/<marketModelId>?sku=<marketSku>.
- Если карточка соответствует товару, значит его можно добавлять в каталог с теми данными, что вы указали. Если карточка определилась неправильно — проверьте данные о товаре. Возможно, их нужно уточнить или дополнить. Кроме того, на этапе добавления товара вы можете указать
marketSKU, который ему подходит по вашему мнению.
{% note info "𝓠 Как определить marketSku товара, найденного на Маркете?" %}
𝓐 Он есть в адресе страницы товара — расположен после sku=.
Например, https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016
{% endnote %}
|⚙️ Лимит: 100 000 товаров в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"offer" : {
"vendor" : "LEVENHUK",
"basicPrice" : {
"value" : 0.9301444243932576
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"description" : "description",
"category" : "category",
"barcodes" : [ "46012300000000", "46012300000000" ],
"vendorCode" : "VNDR-0005A"
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
}, {
"offer" : {
"vendor" : "LEVENHUK",
"basicPrice" : {
"value" : 0.9301444243932576
},
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"offerId" : "offerId",
"description" : "description",
"category" : "category",
"barcodes" : [ "46012300000000", "46012300000000" ],
"vendorCode" : "VNDR-0005A"
},
"mapping" : {
"marketSkuName" : "marketSkuName",
"marketCategoryName" : "marketCategoryName",
"marketCategoryId" : 4,
"marketSku" : 3,
"marketModelId" : 2,
"marketModelName" : "marketModelName"
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Подобранные карточки на Маркете.
По результатам проверки товара полученная через этот запрос карточка может быть заменена на другую.
GetSuggestedOfferMappingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-prices/suggestions
Цены для продвижения товаров (getSuggestedPrices)
{% note warning "" %}
Этот метод устарел. Вместо него используйте отчет «Цены на рынке».
{% endnote %}
{% note warning "" %}
Этот метод подходит только тем магазинам, которые устанавливают цены на товары в рублях.
{% endnote %}
Возвращает цены для продвижения товаров, которые вы размещаете на Маркете.
Товары, для которых нужно получить цены, передаются в теле POST-запроса.
Цены для продвижения зависят от цен, установленных на товары другими партнерами. Если один товар поставляют несколько партнеров, на Маркете сначала продается товар с более низкой ценой. Когда закончится товар по низкой цене, начнет продаваться товар по более высокой цене.
Выходные данные содержат для каждого товара несколько цен, соответствующих разным типам продвижения.
Установить цены на товары можно с помощью запроса POST campaigns/{campaignId}/offer-prices/updates или другими способами: например, указать их в файле с каталогом. Также вы можете использовать стратегии для автоматической установки рекомендованных цен или минимальных цен на Маркете.
Подробно об автоматическом управлении ценами рассказано в Справке Маркета для продавцов.
|⚙️ Лимит: 100 000 товаров в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"marketSku" : 0,
"offerId" : "offerId",
"priceSuggestion" : [ {
"price" : 6.027456183070403,
"type" : "BUYBOX"
}, {
"price" : 6.027456183070403,
"type" : "BUYBOX"
} ]
}, {
"marketSku" : 0,
"offerId" : "offerId",
"priceSuggestion" : [ {
"price" : 6.027456183070403,
"type" : "BUYBOX"
}, {
"price" : 6.027456183070403,
"type" : "BUYBOX"
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список цен для продвижения на Маркете.
SuggestPricesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /businesses/{businessId}/bids
Включение буста продаж и установка ставок (putBidsForBusiness)
Запускает буст продаж — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.
{% cut "Как в кабинете выглядит кампания, созданная через API" %}
{% endcut %}
При первом использовании запроса Маркет: создаст единую на все магазины бизнес-аккаунта кампанию, добавит в нее товары с указанными ставками, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.
Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.
Запрос всегда работает с одной и той же созданной через API кампанией. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. Другими кампаниями управлять через API не получится. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.
Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.
Внести другие изменения в созданную через API кампанию можно в кабинете:
- выключить или включить кампанию;
- изменить ее название;
- выключить или включить ценовую стратегию.
Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.
Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.
{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}
𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.
{% endnote %}
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Все получилось: ставки установлены или обновлены. Если нужно, добавлены новые товары и запущена кампания.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/bids
Включение буста продаж и установка ставок для магазина (putBidsForCampaign)
Запускает буст продаж в указанном магазине — создает и включает кампанию, добавляет в нее товары и назначает на них ставки.
При первом использовании запроса Маркет: создаст кампанию, добавит в нее товары с указанными ставками для заданного магазина, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов.
Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой.
Запрос всегда работает с одной и той же кампанией, созданной через этот запрос или PUT businesses/{businessId}/bids. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя.
Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены.
Внести другие изменения в созданную через API кампанию можно в кабинете:
- выключить или включить кампанию;
- изменить ее название;
- выключить или включить ценовую стратегию.
Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid.
Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов.
{% note info "𝓠 Как посмотреть расходы на буст продаж?" %}
𝓐 Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee.
{% endnote %}
В одном запросе может быть максимум 1500 товаров.
|⚙️ Лимит: 1000 запросов в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/feeds/{feedId}/refresh
Сообщить, что прайс-лист обновился (refreshFeed)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет сообщить, что магазин обновил прайс-лист. После этого Маркет начнет обновление данных на сервисе.
- Магазин обновляет прайс-лист, ссылку на который он указал в кабинете.
- Магазин отправляет Маркету запрос методом
POST campaigns/{campaignId}/feeds/{feedId}/refresh.
- Маркет начинает обновление данных магазина на сервисе.
{% note alert %}
Запрос работает только для включенных магазинов. Если магазин выключен, данные на Маркете не обновятся, даже если HTTP-код — 200 OK. Проверить статус магазина можно с помощью базовых запросов или на странице бизнес-аккаунта.
{% endnote %}
|⚙️ Лимит: 3 запроса в час для одного прайс-листа|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /regions/{regionId}/children
Информация о дочерних регионах (searchRegionChildren)
Возвращает информацию о регионах, являющихся дочерними по отношению к региону, идентификатор которого указан в запросе.
Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).
Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.
|⚙️ Лимит: 50 000 запросов в час|
|-|
Path parameters
regionId (required)
Path Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
Query parameters
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"regions" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Регионы, являющиеся дочерними к указанному в запросе.
GetRegionWithChildrenResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /regions/{regionId}
Информация о регионе (searchRegionsById)
Возвращает информацию о регионе.
Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).
Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.
|⚙️ Лимит: 50 000 запросов в час|
|-|
Path parameters
regionId (required)
Path Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"regions" : [ {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}, {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Найденный регион.
GetRegionsResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Поиск регионов по их имени (searchRegionsByName)
Возвращает информацию о регионе, удовлетворяющем заданным в запросе условиям поиска.
Если найдено несколько регионов, удовлетворяющих условиям поиска, возвращается информация по каждому найденному региону (но не более десяти регионов) для возможности определения нужного региона по родительским регионам.
Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).
Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.
|⚙️ Лимит: 50 000 запросов в час|
|-|
Query parameters
name (required)
Query Parameter —
Название региона.
Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, Москва.
default: null
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"regions" : [ {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}, {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список найденных регионов.
GetRegionsResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/file/send
Отправка файла в чат (sendFileToChat)
Отправляет файл в чат с покупателем.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Query parameters
chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
Form parameters
file (required)
Form Parameter — Содержимое файла. Максимальный размер файла — 5 Мбайт. default: null format: binary
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ. Означает, что файл отправлен.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/chats/message
Отправка сообщения в чат (sendMessageToChat)
Отправляет сообщение в чат с покупателем.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
chatId (required)
Query Parameter — Идентификатор чата. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ. Означает, что сообщение отправлено.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/feeds/{feedId}/params
Изменение параметров прайс-листа (setFeedParams)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет магазину изменить параметры прайс-листа.
Чтобы отредактировать параметр прайс-листа, передайте в теле запроса: name (название параметра) и value (значение параметра).
Чтобы отменить установленное значение, передайте в теле запроса: name (название параметра) и delete=true (удалить значение).
|⚙️ Лимит: 3 запроса в час для одного прайс-листа|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Статус выполнения операции.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/skip-reaction
Отказ от ответа на отзывы (skipGoodsFeedbacksReaction)
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-prices/updates
Установка цен на товары во всех магазинах (updateBusinessPrices)
Устанавливает базовые цены. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Маркет принял информацию о новых ценах.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers/update
Изменение условий продажи товаров в магазине (updateCampaignOffers)
Изменяет параметры продажи товаров в конкретном магазине: доступность товара, условия доставки и самовывоза, применяемую ставку НДС.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ 200 обозначает, что новые параметры получены Маркетом и скоро вступят в силу.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/comments/update
Добавление нового или изменение созданного комментария (updateGoodsFeedbackComment)
Добавляет новый комментарий магазина или изменяет комментарий, который магазин оставлял ранее.
Для создания комментария к отзыву передайте только идентификатор отзыва feedbackId.
Чтобы добавить комментарий к другому комментарию, передайте:
feedbackId — идентификатор отзыва;comment.parentId — идентификатор родительского комментария.
Чтобы изменить комментарий, передайте:
feedbackId— идентификатор отзыва;comment.id — идентификатор комментария, который нужно изменить.
Если передать одновременно comment.parentId и comment.id, будет изменен существующий комментарий.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 0,
"text" : "text",
"canModify" : true,
"parentId" : 6,
"status" : "PUBLISHED"
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о добавленном или измененном комментарии.
UpdateGoodsFeedbackCommentResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-cards/update
Редактирование категорийных характеристик товара (updateOfferContent)
Редактирует характеристики товара, которые специфичны для категории, к которой он относится.
{% note warning "Здесь только то, что относится к конкретной категории" %}
Если вам нужно изменить основные параметры товара (название, описание, изображения, видео, производитель, штрихкод), воспользуйтесь запросом POST businesses/{businessId}/offer-mappings/update.
{% endnote %}
Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"results" : [ {
"warnings" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ]
}, {
"warnings" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "OFFER_NOT_FOUND",
"message" : "message"
} ]
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Запрос выполнен корректно, данные обработаны.
{% note warning "Ответ 200 сам по себе не значит, что переданные значения корректны" %}
Обязательно посмотрите детали ответа: status и перечень ошибок, если он есть.
Даже если ошибка допущена в характеристиках всего одного товара, никакие изменения из запроса в каталог не попадут.
{% endnote %}
Если в status вернулось ERROR, убедитесь, что:
- все обязательные характеристики заполнены;
- характеристики действительно существуют в указанных категориях;
- значения соответствуют характеристикам;
- ваши собственные значения имеют нужный тип данных.
Найти проблемы помогут поля errors и warnings.
UpdateOfferContentResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-mapping-entries/updates
Добавление и редактирование товаров в каталоге (updateOfferMappingEntries)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/update.
{% endnote %}
Добавляет товары, указанные в запросе, в ваш каталог товаров и редактирует уже имеющиеся товары.
Информацию о товарах нужно передать в теле POST-запроса.
У каждого товара должен быть ваш SKU — уникальный код, который вы используете для идентификации товара:
- Чтобы добавить в каталог новый товар, укажите в параметре
shopSku ваш SKU, которого еще нет в каталоге.
- Чтобы отредактировать товар из каталога, укажите в параметре
shopSku ваш SKU этого товара в каталоге.
В обоих случаях в запросе нужно передать полное описание товара, даже если вы хотите изменить только несколько характеристик.
Если вы знаете, какой карточке товара на Маркете соответствует ваш товар, укажите ее идентификатор (SKU на Маркете) во входном параметре mapping. Получить SKU на Маркете рекомендованной карточки товара можно с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/suggestions или через кабинет. Если SKU на Маркете не указан, сотрудники Маркета сами подберут или создадут подходящую карточку товара, либо у него появится статус NEED_CONTENT (нужно найти карточку или создать ее самостоятельно) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.
Перед публикацией товары проходят модерацию. Если в одном из отправленных товаров найдена ошибка, ответ на запрос будет иметь HTTP-код 400 Bad Request, и ни один из товаров не отправится на модерацию. При этом если вы не передадите все обязательные параметры для какого‑либо товара, после модерации у него появится статус NEED_INFO (в описании товара не хватает информации) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.
В одном запросе можно добавить не более 500 товаров.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5 000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Статус выполнения операции.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-mappings/update
Добавление товаров в каталог и изменение информации о них (updateOfferMappings)
Добавляет товары в каталог, передает их категории на Маркете и характеристики, необходимые для этих категории. Также редактирует информацию об уже имеющихся товарах.
Список категорий Маркета можно получить с помощью запроса POST categories/tree, а характеристики товаров по категориям с помощью POST category/{categoryId}/parameters.
Чтобы добавить новый товар, передайте его с новым идентификатором, который раньше никогда не использовался в каталоге. Старайтесь сразу передать как можно больше информации — она потребуется Маркету для подбора подходящей карточки или создания новой. Если известно, какой карточке на Маркете соответствует товар, можно сразу указать идентификатор этой карточки (SKU на Маркете) в поле marketSKU.
Для новых товаров обязательно укажите параметры: offerId, name, marketCategoryId или category, pictures, vendor, description.
Чтобы отредактировать информацию о товаре, передайте новые данные, указав в offerId соответствующий ваш SKU. Поля, в которых ничего не меняется, можно не передавать.
Чтобы удалить характеристики, которые заданы в параметрах с типом string, передайте пустое значение.
Параметр offerId должен быть уникальным для всех товаров, которые вы передаете.
{% note warning "Правила использования SKU" %}
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
{% endnote %}
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"results" : [ {
"warnings" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ]
}, {
"warnings" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ],
"offerId" : "offerId",
"errors" : [ {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
}, {
"parameterId" : 0,
"type" : "UNKNOWN_CATEGORY",
"message" : "message"
} ]
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Все обязательные поля товаров заполнены, поэтому новые товары и внесенные изменения сохранены в каталоге.
UpdateOfferMappingsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-prices/updates
Установка цен на товары в конкретном магазине (updatePrices)
Устанавливает цены на товары в магазине. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.
{% note warning "Метод только для отдельных магазинов" %}
Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.
Для управления базовыми ценами используйте POST businesses/{businessId}/offer-prices/updates.
{% endnote %}
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Маркет принял информацию о новых ценах.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos/offers/update
Добавление товаров в акцию или изменение их цен (updatePromoOffers)
Добавляет товары в акцию или изменяет цены на товары, которые участвуют в акции.
Изменения начинают действовать в течение 4–6 часов.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"rejectedOffers" : [ {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
}, {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
} ],
"warningOffers" : [ {
"warnings" : [ {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
}, {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
} ],
"offerId" : "offerId"
}, {
"warnings" : [ {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
}, {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
} ],
"offerId" : "offerId"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Результат добавления товаров в акцию или обновления их цен.
UpdatePromoOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feedback/updates
Новые и обновленные отзывы о магазине (getFeedbackAndCommentUpdates)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает новые и обновленные отзывы о магазине на Маркете.
Результаты возвращаются постранично, одна страница содержит не более 20 отзывов. Выходные данные содержат идентификатор следующей страницы.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
from_date (optional)
Query Parameter —
Начальная дата обновления отзывов.
Если параметр указан, возвращаются отзывы, которые были написаны или обновлены с этой даты.
Формат даты: ГГГГ-ММ-ДД.
default: null format: date
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
},
"feedbackList" : [ {
"comments" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"shop" : {
"name" : "name"
},
"author" : {
"name" : "name",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}
},
"verified" : true,
"recommend" : true,
"grades" : {
"average" : 5.962133916683182,
"agreeCount" : 5,
"rejectCount" : 2,
"factors" : [ {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
}, {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
} ]
},
"pro" : "pro",
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"text" : "text",
"state" : "LAST",
"contra" : "contra",
"resolved" : true,
"order" : {
"delivery" : "DELIVERY",
"shopOrderId" : "shopOrderId"
}
}, {
"comments" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"children" : [ null, null ],
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 6,
"body" : "body",
"parentId" : 1,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"shop" : {
"name" : "name"
},
"author" : {
"name" : "name",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}
},
"verified" : true,
"recommend" : true,
"grades" : {
"average" : 5.962133916683182,
"agreeCount" : 5,
"rejectCount" : 2,
"factors" : [ {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
}, {
"description" : "description",
"id" : 7,
"title" : "title",
"value" : 9
} ]
},
"pro" : "pro",
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"id" : 0,
"text" : "text",
"state" : "LAST",
"contra" : "contra",
"resolved" : true,
"order" : {
"delivery" : "DELIVERY",
"shopOrderId" : "shopOrderId"
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список отзывов для магазина.
GetFeedbackListResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feeds/{feedId}
Информация о прайс-листе (getFeed)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает информацию о прайс-листе, размещенном на Маркете для заданного магазина. Также ресурс возвращает результаты автоматических проверок прайс-листа.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"feed" : {
"password" : "password",
"download" : {
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 5
}
},
"uploadDate" : "2000-01-23T04:56:07.000+00:00",
"publication" : {
"priceAndStockUpdate" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
},
"full" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
}
},
"name" : "name",
"id" : 0,
"placement" : {
"totalOffersCount" : 5
},
"login" : "login",
"url" : "url",
"content" : {
"rejectedOffersCount" : 6,
"error" : {
"type" : "PARSE_ERROR"
},
"status" : "ERROR",
"totalOffersCount" : 1
}
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о прайс-листе.
GetFeedResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feeds/{feedId}/index-logs
Отчет по индексации прайс-листа (getFeedIndexLogs)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает отчет по индексации прайс-листа для заданного магазина. Отчет позволяет получить статистику загрузки прайс-листа и результаты его автоматических проверок.
Данные в отчете возвращаются в порядке убывания значений параметра generationId.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Query parameters
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
published_time_from (optional)
Query Parameter —
Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
Значение по умолчанию: последние восемь дней со времени отправки запроса.
default: null format: date-time
published_time_to (optional)
Query Parameter —
Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-31T00:42:42+03:00.
Значение по умолчанию: дата и время отправки запроса.
{% note info %}
Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра published_time_to. Значение параметра не должно быть датой из будущего.
{% endnote %}
default: null format: date-time
status (optional)
Query Parameter —
Статус индексации и проверки прайс-листа на соответствие техническим требованиям.
Возможные значения:
ERROR — произошли ошибки.OK — обработан без ошибок.WARNING — наблюдались некритичные проблемы.
default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"feed" : {
"id" : 0
},
"total" : 2,
"indexLogRecords" : [ {
"offers" : {
"rejectedCount" : 5,
"totalCount" : 5
},
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"generationId" : 6,
"indexType" : "DIFF",
"publishedTime" : "2000-01-23T04:56:07.000+00:00",
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 1
},
"downloadTime" : "2000-01-23T04:56:07.000+00:00",
"status" : "ERROR"
}, {
"offers" : {
"rejectedCount" : 5,
"totalCount" : 5
},
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"generationId" : 6,
"indexType" : "DIFF",
"publishedTime" : "2000-01-23T04:56:07.000+00:00",
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 1
},
"downloadTime" : "2000-01-23T04:56:07.000+00:00",
"status" : "ERROR"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Отчет по индексации прайс-листа.
GetFeedIndexLogsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/feeds
Список прайс-листов магазина (getFeeds)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Возвращает список прайс-листов, размещенных на Маркете для магазина. Также ресурс возвращает результаты автоматических проверок прайс-листов.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"feeds" : [ {
"password" : "password",
"download" : {
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 5
}
},
"uploadDate" : "2000-01-23T04:56:07.000+00:00",
"publication" : {
"priceAndStockUpdate" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
},
"full" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
}
},
"name" : "name",
"id" : 0,
"placement" : {
"totalOffersCount" : 5
},
"login" : "login",
"url" : "url",
"content" : {
"rejectedOffersCount" : 6,
"error" : {
"type" : "PARSE_ERROR"
},
"status" : "ERROR",
"totalOffersCount" : 1
}
}, {
"password" : "password",
"download" : {
"error" : {
"description" : "description",
"type" : "DOWNLOAD_ERROR",
"httpStatusCode" : 5
}
},
"uploadDate" : "2000-01-23T04:56:07.000+00:00",
"publication" : {
"priceAndStockUpdate" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
},
"full" : {
"fileTime" : "2000-01-23T04:56:07.000+00:00",
"publishedTime" : "2000-01-23T04:56:07.000+00:00"
}
},
"name" : "name",
"id" : 0,
"placement" : {
"totalOffersCount" : 5
},
"login" : "login",
"url" : "url",
"content" : {
"rejectedOffersCount" : 6,
"error" : {
"type" : "PARSE_ERROR"
},
"status" : "ERROR",
"totalOffersCount" : 1
}
} ]
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список прайс-листов.
GetFeedsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/feeds/{feedId}/refresh
Сообщить, что прайс-лист обновился (refreshFeed)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет сообщить, что магазин обновил прайс-лист. После этого Маркет начнет обновление данных на сервисе.
- Магазин обновляет прайс-лист, ссылку на который он указал в кабинете.
- Магазин отправляет Маркету запрос методом
POST campaigns/{campaignId}/feeds/{feedId}/refresh.
- Маркет начинает обновление данных магазина на сервисе.
{% note alert %}
Запрос работает только для включенных магазинов. Если магазин выключен, данные на Маркете не обновятся, даже если HTTP-код — 200 OK. Проверить статус магазина можно с помощью базовых запросов или на странице бизнес-аккаунта.
{% endnote %}
|⚙️ Лимит: 3 запроса в час для одного прайс-листа|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/feeds/{feedId}/params
Изменение параметров прайс-листа (setFeedParams)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет магазину изменить параметры прайс-листа.
Чтобы отредактировать параметр прайс-листа, передайте в теле запроса: name (название параметра) и value (значение параметра).
Чтобы отменить установленное значение, передайте в теле запроса: name (название параметра) и delete=true (удалить значение).
|⚙️ Лимит: 3 запроса в час для одного прайс-листа|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
feedId (required)
Path Parameter — Идентификатор прайс-листа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Статус выполнения операции.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/comments/delete
Удаление комментария к отзыву (deleteGoodsFeedbackComment)
Удаляет комментарий магазина.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/comments
Получение комментариев к отзыву (getGoodsFeedbackComments)
Возвращает комментарии к отзыву.
Результаты возвращаются постранично, одна страница содержит не более 20 комментариев.
Комментарии расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"comments" : [ {
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 0,
"text" : "text",
"canModify" : true,
"parentId" : 6,
"status" : "PUBLISHED"
}, {
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 0,
"text" : "text",
"canModify" : true,
"parentId" : 6,
"status" : "PUBLISHED"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Дерево комментариев к отзыву.
GetGoodsFeedbackCommentsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback
Получение отзывов о товарах продавца (getGoodsFeedbacks)
Возвращает все отзывы о товарах продавца по указанным фильтрам.
Результаты возвращаются постранично, одна страница содержит не более 20 отзывов.
Отзывы расположены в порядке публикации, поэтому вы можете передавать определенный идентификатор страницы в page_token, если вы получали его ранее.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"feedbacks" : [ {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"needReaction" : true,
"identifiers" : {
"orderId" : 6,
"modelId" : 1
},
"author" : "author",
"feedbackId" : 0,
"description" : {
"advantages" : "advantages",
"disadvantages" : "disadvantages",
"comment" : "comment"
},
"media" : {
"videos" : [ "videos", "videos" ],
"photos" : [ "photos", "photos" ]
},
"statistics" : {
"commentsCount" : 5,
"rating" : 3,
"paidAmount" : 2,
"recommended" : true
}
}, {
"createdAt" : "2000-01-23T04:56:07.000+00:00",
"needReaction" : true,
"identifiers" : {
"orderId" : 6,
"modelId" : 1
},
"author" : "author",
"feedbackId" : 0,
"description" : {
"advantages" : "advantages",
"disadvantages" : "disadvantages",
"comment" : "comment"
},
"media" : {
"videos" : [ "videos", "videos" ],
"photos" : [ "photos", "photos" ]
},
"statistics" : {
"commentsCount" : 5,
"rating" : 3,
"paidAmount" : 2,
"recommended" : true
}
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список отзывов.
GetGoodsFeedbackResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/skip-reaction
Отказ от ответа на отзывы (skipGoodsFeedbacksReaction)
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/goods-feedback/comments/update
Добавление нового или изменение созданного комментария (updateGoodsFeedbackComment)
Добавляет новый комментарий магазина или изменяет комментарий, который магазин оставлял ранее.
Для создания комментария к отзыву передайте только идентификатор отзыва feedbackId.
Чтобы добавить комментарий к другому комментарию, передайте:
feedbackId — идентификатор отзыва;comment.parentId — идентификатор родительского комментария.
Чтобы изменить комментарий, передайте:
feedbackId— идентификатор отзыва;comment.id — идентификатор комментария, который нужно изменить.
Если передать одновременно comment.parentId и comment.id, будет изменен существующий комментарий.
|⚙️ Лимит: 1 000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"author" : {
"name" : "name",
"type" : "USER"
},
"id" : 0,
"text" : "text",
"canModify" : true,
"parentId" : 6,
"status" : "PUBLISHED"
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о добавленном или измененном комментарии.
UpdateGoodsFeedbackCommentResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/stats/skus
Отчет по товарам (getGoodsStats)
Возвращает подробный отчет по товарам, которые вы разместили на Маркете. С помощью отчета вы можете узнать, например, об остатках на складе, об условиях хранения ваших товаров и т. д.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"shopSkus" : [ {
"shopSku" : "shopSku",
"marketSku" : 0,
"price" : 6.027456183070403,
"name" : "name",
"warehouses" : [ {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
}, {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
} ],
"weightDimensions" : {
"length" : 5.962133916683182,
"width" : 5.637376656633329,
"weight" : 7.061401241503109,
"height" : 2.3021358869347655
},
"categoryName" : "categoryName",
"categoryId" : 1,
"pictures" : [ "pictures", "pictures" ],
"tariffs" : [ {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
}, {
"shopSku" : "shopSku",
"marketSku" : 0,
"price" : 6.027456183070403,
"name" : "name",
"warehouses" : [ {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
}, {
"name" : "name",
"id" : 9,
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ]
} ],
"weightDimensions" : {
"length" : 5.962133916683182,
"width" : 5.637376656633329,
"weight" : 7.061401241503109,
"height" : 2.3021358869347655
},
"categoryName" : "categoryName",
"categoryId" : 1,
"pictures" : [ "pictures", "pictures" ],
"tariffs" : [ {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 2.027123023002322,
"type" : "AGENCY_COMMISSION",
"percent" : 3.616076749251911,
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Отчет по товарам.
GetGoodsStatsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/hidden-offers
Скрытие товаров и настройки скрытия (addHiddenOffers)
Скрывает товары магазина на Маркете.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Настройки скрытия получены и скоро вступят в силу.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/hidden-offers/delete
Возобновление показа товаров (deleteHiddenOffers)
Возобновляет показ скрытых вами товаров магазина на Маркете.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Показ товаров возобновлен.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/hidden-offers
Информация о скрытых вами товарах (getHiddenOffers)
Возвращает список скрытых вами товаров для заданного магазина.
В списке будут товары, скрытые любым способом — по API, с помощью YML-фида, в кабинете и так далее.
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
offer_id (optional)
Query Parameter — Идентификатор скрытого предложения. default: null
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
offset (optional)
Query Parameter —
Позиция в списке, начиная с которой возвращаются результаты ответа.
Используется вместе с параметром limit.
Если задан offset, параметры page_number и page_size игнорируются.
offset игнорируется, если задан page_token.
default: null format: int32
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"hiddenOffers" : [ {
"offerId" : "offerId"
}, {
"offerId" : "offerId"
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о скрытых вами товарах.
GetHiddenOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Информация об одной модели (getModel)
Возвращает информацию о модели товара.
Для методов GET models, GET models/{modelId} и POST models действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.
|⚙️ Лимит: рассчитывается индивидуально|
|-|
Path parameters
modelId (required)
Path Parameter — Идентификатор модели товара. default: null format: int64
Query parameters
regionId (required)
Query Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
currency (optional)
Query Parameter —
Валюта, в которой отображаются цены предложений на страницах с результатами поиска.
Возможные значения:
Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
default: null
Return type
Example data
Content-Type: application/json
{
"models" : [ {
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
}
}, {
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
}
} ],
"regionId" : 0,
"currency" : "RUR"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о модели.
GetModelsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /models/{modelId}/offers
Список предложений для одной модели (getModelOffers)
Возвращает информацию о первых десяти предложениях, расположенных на карточке модели.
Предложения выдаются для определенного региона и располагаются в том же порядке, в котором они показываются в выдаче Маркета на карточке модели.
Для групповых моделей метод не поддерживается. Идентификатор групповой модели игнорируется.
Для методов GET models/{modelId}/offers и POST models/offers действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.
|⚙️ Лимит: рассчитывается индивидуально|
|-|
Path parameters
modelId (required)
Path Parameter — Идентификатор модели товара. default: null format: int64
Query parameters
regionId (required)
Query Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
currency (optional)
Query Parameter —
Валюта, в которой отображаются цены предложений на страницах с результатами поиска.
Возможные значения:
Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
default: null
orderByPrice (optional)
Query Parameter —
Направление сортировки по цене.
Возможные значения:
ASC — сортировка по возрастанию.DESC — сортировка по убыванию.
Значение по умолчанию: предложения выводятся в произвольном порядке.
default: null
count (optional)
Query Parameter — Количество предложений на странице ответа. default: 10 format: int32
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
Return type
Example data
Content-Type: application/json
{
"models" : [ {
"offers" : [ {
"shopRating" : 9,
"preDiscountPrice" : 5.962133916683182,
"shippingCost" : 7.061401241503109,
"pos" : 1,
"regionId" : 2,
"price" : 5.637376656633329,
"name" : "name",
"discount" : 6,
"shopName" : "shopName",
"inStock" : 3
}, {
"shopRating" : 9,
"preDiscountPrice" : 5.962133916683182,
"shippingCost" : 7.061401241503109,
"pos" : 1,
"regionId" : 2,
"price" : 5.637376656633329,
"name" : "name",
"discount" : 6,
"shopName" : "shopName",
"inStock" : 3
} ],
"onlineOffers" : 4,
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
},
"offlineOffers" : 2
}, {
"offers" : [ {
"shopRating" : 9,
"preDiscountPrice" : 5.962133916683182,
"shippingCost" : 7.061401241503109,
"pos" : 1,
"regionId" : 2,
"price" : 5.637376656633329,
"name" : "name",
"discount" : 6,
"shopName" : "shopName",
"inStock" : 3
}, {
"shopRating" : 9,
"preDiscountPrice" : 5.962133916683182,
"shippingCost" : 7.061401241503109,
"pos" : 1,
"regionId" : 2,
"price" : 5.637376656633329,
"name" : "name",
"discount" : 6,
"shopName" : "shopName",
"inStock" : 3
} ],
"onlineOffers" : 4,
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
},
"offlineOffers" : 2
} ],
"regionId" : 7,
"currency" : "RUR"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список предложений для модели.
GetModelsOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Информация о нескольких моделях (getModels)
Возвращает информацию о моделях товаров.
В одном запросе можно получить информацию не более чем о 100 моделях.
Для методов GET models, GET models/{modelId} и POST models действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.
|⚙️ Лимит: рассчитывается индивидуально|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
regionId (required)
Query Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
currency (optional)
Query Parameter —
Валюта, в которой отображаются цены предложений на страницах с результатами поиска.
Возможные значения:
Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
default: null
Return type
Example data
Content-Type: application/json
{
"models" : [ {
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
}
}, {
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
}
} ],
"regionId" : 0,
"currency" : "RUR"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о моделях.
GetModelsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Список предложений для нескольких моделей (getModelsOffers)
Возвращает информацию о первых десяти предложениях, расположенных на карточках моделей, идентификаторы которых указаны в запросе.
Предложения выдаются для определенного региона и располагаются в том же порядке, в котором они показываются в выдаче Маркета на карточке модели.
Для групповых моделей выдача предложений не поддерживается. Идентификаторы групповых моделей игнорируются.
В одном запросе можно получить информацию о предложениях не более чем для 100 моделей.
Для методов GET models/{modelId}/offers и POST models/offers действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.
|⚙️ Лимит: рассчитывается индивидуально|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
regionId (required)
Query Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
currency (optional)
Query Parameter —
Валюта, в которой отображаются цены предложений на страницах с результатами поиска.
Возможные значения:
Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
default: null
orderByPrice (optional)
Query Parameter —
Направление сортировки по цене.
Возможные значения:
ASC — сортировка по возрастанию.DESC — сортировка по убыванию.
Значение по умолчанию: предложения выводятся в произвольном порядке.
default: null
Return type
Example data
Content-Type: application/json
{
"models" : [ {
"offers" : [ {
"shopRating" : 9,
"preDiscountPrice" : 5.962133916683182,
"shippingCost" : 7.061401241503109,
"pos" : 1,
"regionId" : 2,
"price" : 5.637376656633329,
"name" : "name",
"discount" : 6,
"shopName" : "shopName",
"inStock" : 3
}, {
"shopRating" : 9,
"preDiscountPrice" : 5.962133916683182,
"shippingCost" : 7.061401241503109,
"pos" : 1,
"regionId" : 2,
"price" : 5.637376656633329,
"name" : "name",
"discount" : 6,
"shopName" : "shopName",
"inStock" : 3
} ],
"onlineOffers" : 4,
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
},
"offlineOffers" : 2
}, {
"offers" : [ {
"shopRating" : 9,
"preDiscountPrice" : 5.962133916683182,
"shippingCost" : 7.061401241503109,
"pos" : 1,
"regionId" : 2,
"price" : 5.637376656633329,
"name" : "name",
"discount" : 6,
"shopName" : "shopName",
"inStock" : 3
}, {
"shopRating" : 9,
"preDiscountPrice" : 5.962133916683182,
"shippingCost" : 7.061401241503109,
"pos" : 1,
"regionId" : 2,
"price" : 5.637376656633329,
"name" : "name",
"discount" : 6,
"shopName" : "shopName",
"inStock" : 3
} ],
"onlineOffers" : 4,
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
},
"offlineOffers" : 2
} ],
"regionId" : 7,
"currency" : "RUR"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список предложений для моделей.
GetModelsOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Поиск модели товара (searchModels)
Возвращает информацию о моделях, удовлетворяющих заданным в запросе условиям поиска.
В одном запросе можно получить информацию не более чем о 100 моделях.
Для методов GET models, GET models/{modelId} и POST models действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.
|⚙️ Лимит: рассчитывается индивидуально|
|-|
Query parameters
query (required)
Query Parameter — Поисковый запрос по названию модели товара. default: null
regionId (required)
Query Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
currency (optional)
Query Parameter —
Валюта, в которой отображаются цены предложений на страницах с результатами поиска.
Возможные значения:
Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
default: null
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"models" : [ {
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
}
}, {
"name" : "name",
"id" : 0,
"prices" : {
"avg" : 6.027456183070403,
"min" : 5.962133916683182,
"max" : 1.4658129805029452
}
} ],
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
},
"regionId" : 5,
"currency" : "RUR"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о моделях.
SearchModelsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offer-mapping-entries
Список товаров в каталоге (getOfferMappingEntries)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings.
{% endnote %}
Для каждого товара, который вы размещаете на Маркете, возвращается информация о карточках Маркета, к которым привязан этот товар:
- Идентификатор текущей карточки (marketSku), карточки, которая проходит модерацию и последней отклоненной карточки.
- Описание товара, которое указано на карточке Маркета. Например, размер упаковки и вес товара.
Результаты возвращаются постранично. Выходные данные содержат идентификатор следующей страницы.
{% note info %}
Количество товаров в каталоге магазина считается по данным за последние семь дней (не включая сегодня).
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
offer_id (optional)
Query Parameter — Идентификатор товара в каталоге. default: null
shop_sku (optional)
Query Parameter —
Ваш SKU товара.
Параметр может быть указан несколько раз, например:
...shop_sku=123&shop_sku=129&shop_sku=141...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
mapping_kind (optional)
Query Parameter — Тип маппинга. default: null
status (optional)
Query Parameter —
Фильтрация по статусу публикации товара:
READY — товар прошел модерацию.IN_WORK — товар проходит модерацию.NEED_CONTENT — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее.NEED_INFO — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара.REJECTED — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.SUSPENDED — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.OTHER — товар не прошел модерацию по другой причине.
Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...status=READY,IN_WORK...
...status=READY&status=IN_WORK...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
availability (optional)
Query Parameter —
Фильтрация по планам поставок товара:
ACTIVE — поставки будут.INACTIVE — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять.DELISTED — архив: товар закончился на складе, и его поставок больше не будет.
Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
category_id (optional)
Query Parameter —
Фильтрация по идентификатору категории на Маркете.
Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом POST categories/tree.
Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
vendor (optional)
Query Parameter —
Фильтрация по бренду товара.
Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:
...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...
Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.
Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе Кодирование URL русскоязычной Википедии.
В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
default: null
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offerMappingEntries" : [ {
"offer" : {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
},
"mapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"awaitingModerationMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"rejectedMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
}
}, {
"offer" : {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
},
"mapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"awaitingModerationMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
},
"rejectedMapping" : {
"modelId" : 7,
"marketSku" : 4,
"categoryId" : 1
}
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о товарах в каталоге.
GetOfferMappingEntriesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-mapping-entries/suggestions
Рекомендованные карточки для товаров (getSuggestedOfferMappingEntries)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/suggestions.
{% endnote %}
Возвращает идентификаторы карточек товаров на Маркете, рекомендованных для ваших товаров.
Каждому товару, который вы размещаете, должна соответствовать карточка товара на Маркете со своим идентификатором — SKU на Маркете. Он указывается в URL карточки товара, после «...sku=», например:
##https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016…##
Чтобы получить для товаров рекомендованные SKU на Маркете, передайте в теле POST-запроса как можно больше информации о них: названия, производителей, штрихкоды, цены и т. д.
Полученные SKU можно передать вместе с информацией о ваших товарах с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/updates.
В одном запросе можно получить не более 500 рекомендаций.
|⚙️ Лимит: 100 000 рекомендаций в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"marketCategoryId" : 4,
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"marketModelId" : 7,
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"marketSkuName" : "marketSkuName",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"marketModelName" : "marketModelName",
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"marketCategoryName" : "marketCategoryName",
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
}, {
"manufacturerCountries" : [ "manufacturerCountries", "manufacturerCountries" ],
"marketCategoryId" : 4,
"certificate" : "certificate",
"description" : "description",
"availability" : "ACTIVE",
"marketModelId" : 7,
"pictures" : [ "pictures", "pictures" ],
"vendorCode" : "VNDR-0005A",
"manufacturer" : "manufacturer",
"marketSkuName" : "marketSkuName",
"urls" : [ "urls", "urls" ],
"deliveryDurationDays" : 5,
"feedId" : 0,
"vendor" : "LEVENHUK",
"price" : 2.027123023002322,
"transportUnitSize" : 1,
"id" : "id",
"lifeTime" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"shelfLife" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"supplyScheduleDays" : [ "MONDAY", "MONDAY" ],
"marketModelName" : "marketModelName",
"lifeTimeDays" : 9,
"quantumOfSupply" : 5,
"barcodes" : [ "46012300000000", "46012300000000" ],
"customsCommodityCodes" : [ "customsCommodityCodes", "customsCommodityCodes" ],
"processingState" : {
"notes" : [ {
"payload" : "payload",
"type" : "ASSORTMENT"
}, {
"payload" : "payload",
"type" : "ASSORTMENT"
} ],
"status" : "UNKNOWN"
},
"marketCategoryName" : "marketCategoryName",
"shopSku" : "shopSku",
"boxCount" : 2,
"minShipment" : 6,
"name" : "Ударная дрель Makita HP1630, 710 Вт",
"shelfLifeDays" : 7,
"guaranteePeriod" : {
"timePeriod" : 6,
"comment" : "comment",
"timeUnit" : "HOUR"
},
"weightDimensions" : {
"length" : 65.55,
"width" : 50.7,
"weight" : 1.001,
"height" : 20
},
"category" : "category",
"guaranteePeriodDays" : 3
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о товарах в каталоге.
GetSuggestedOfferMappingEntriesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-mapping-entries/updates
Добавление и редактирование товаров в каталоге (updateOfferMappingEntries)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST businesses/{businessId}/offer-mappings/update.
{% endnote %}
Добавляет товары, указанные в запросе, в ваш каталог товаров и редактирует уже имеющиеся товары.
Информацию о товарах нужно передать в теле POST-запроса.
У каждого товара должен быть ваш SKU — уникальный код, который вы используете для идентификации товара:
- Чтобы добавить в каталог новый товар, укажите в параметре
shopSku ваш SKU, которого еще нет в каталоге.
- Чтобы отредактировать товар из каталога, укажите в параметре
shopSku ваш SKU этого товара в каталоге.
В обоих случаях в запросе нужно передать полное описание товара, даже если вы хотите изменить только несколько характеристик.
Если вы знаете, какой карточке товара на Маркете соответствует ваш товар, укажите ее идентификатор (SKU на Маркете) во входном параметре mapping. Получить SKU на Маркете рекомендованной карточки товара можно с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/suggestions или через кабинет. Если SKU на Маркете не указан, сотрудники Маркета сами подберут или создадут подходящую карточку товара, либо у него появится статус NEED_CONTENT (нужно найти карточку или создать ее самостоятельно) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.
Перед публикацией товары проходят модерацию. Если в одном из отправленных товаров найдена ошибка, ответ на запрос будет иметь HTTP-код 400 Bad Request, и ни один из товаров не отправится на модерацию. При этом если вы не передадите все обязательные параметры для какого‑либо товара, после модерации у него появится статус NEED_INFO (в описании товара не хватает информации) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries.
В одном запросе можно добавить не более 500 товаров.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5 000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Статус выполнения операции.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers/delete
Удаление товаров из ассортимента магазина (deleteCampaignOffers)
Удаляет заданные товары из заданного магазина.
{% note warning "Запрос удаляет товары именно из конкретного магазина" %}
На продажи в других магазинах и на наличие товара в общем каталоге он не влияет.
{% endnote %}
Товар не получится удалить, если он хранится на складах Маркета.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"notDeletedOfferIds" : [ null, null ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Если удалось удалить не все товары, с ответом 200 вернется список тех, что были в запросе, но остались в магазине.
DeleteCampaignOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offers/all
Все предложения магазина (getAllOffers)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет максимально быстро получить информацию обо всех предложениях магазина, размещенных на Маркете. Возвращает результат в виде сегментов нефиксированного размера.
В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Яндекс Маркета, с которой соотнесено предложение, а также аукционные ставки на него.
{% note info %}
Количество предложений считается по данным за последние семь дней (не включая сегодня).
Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
chunk (optional)
Query Parameter —
Номер сегмента с результатами.
Значение по умолчанию: 0.
{% note info %}
Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.
{% endnote %}
{% note alert %}
Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать chunk=0 и т. д.
{% endnote %}
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"offers" : [ {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
}, {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
} ]
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Предложения магазина.
GetAllOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers
Информация о товарах, которые размещены в заданном магазине (getCampaignOffers)
Возвращает список товаров, которые размещены в заданном магазине. Для каждого товара указываются параметры размещения.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"campaignPrice" : {
"vat" : 5,
"discountBase" : 5.962133916683182,
"currencyId" : "RUR",
"value" : 1.4658129805029452,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"available" : true,
"offerId" : "offerId",
"quantum" : {
"minQuantity" : 1,
"stepQuantity" : 60
},
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"status" : "PUBLISHED"
}, {
"campaignPrice" : {
"vat" : 5,
"discountBase" : 5.962133916683182,
"currencyId" : "RUR",
"value" : 1.4658129805029452,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"basicPrice" : {
"discountBase" : 0.23021358869347652,
"currencyId" : "RUR",
"value" : 0.5637376656633328,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
},
"warnings" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"available" : true,
"offerId" : "offerId",
"quantum" : {
"minQuantity" : 1,
"stepQuantity" : 60
},
"errors" : [ {
"comment" : "comment",
"message" : "message"
}, {
"comment" : "comment",
"message" : "message"
} ],
"status" : "PUBLISHED"
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров, размещенных в заданном магазине.
GetCampaignOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offers/recommendations
Рекомендации Маркета, касающиеся цен (getOfferRecommendations)
Метод возвращает рекомендации нескольких типов.
1. Порог для привлекательной цены. Он нужен для участия в софинансировании скидок.
Показывает, какие цены для участия нужно установить, чтобы получить максимальные шансы на срабатывание скидок, софинансируемых Маркетом. Как это устроено
2. Оценка привлекательности цен на витрине.
Привлекательность влияет на вероятность срабатывания скидок за счет Маркета. Как это устроено
В запросе можно использовать фильтры.
Результаты возвращаются постранично.
|⚙️ Лимит: 100 запросов в минуту|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
},
"offerRecommendations" : [ {
"offer" : {
"shows" : 0,
"price" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitiveness" : "OPTIMAL",
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}
},
"recommendation" : {
"recommendedCofinancePrice" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitivenessThresholds" : {
"optimalPrice" : {
"value" : 0.9301444243932576
},
"averagePrice" : {
"value" : 0.9301444243932576
}
}
}
}, {
"offer" : {
"shows" : 0,
"price" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitiveness" : "OPTIMAL",
"cofinancePrice" : {
"value" : 0.7061401241503109,
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}
},
"recommendation" : {
"recommendedCofinancePrice" : {
"value" : 0.9301444243932576
},
"offerId" : "offerId",
"competitivenessThresholds" : {
"optimalPrice" : {
"value" : 0.9301444243932576
},
"averagePrice" : {
"value" : 0.9301444243932576
}
}
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров с рекомендациями.
GetOfferRecommendationsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offers
Предложения магазина (getOffers)
{% note warning "" %}
Этот метод устарел. Не используйте его.
{% endnote %}
Позволяет фильтровать информацию о предложениях магазина, размещенных на Маркете, и искать предложения по заданному поисковому запросу.
Поиск предложений, размещенных на Маркете, работает по поисковому запросу аналогично поиску Маркета. Результаты возвращаются с использованием пейджера.
В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Маркета, с которой соотнесено предложение, и аукционные ставки на него.
{% note info %}
Из-за особенностей поиска Маркета иногда на последних страницах пейджера фактическое количество результатов оказывается меньше количества, указанного ранее на предыдущих страницах.
В связи с этим настоятельно рекомендуется анализировать содержимое параметра pager для каждой полученной страницы.
{% endnote %}
{% note info %}
Количество предложений считается по данным за последние семь дней (не включая сегодня).
Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
query (optional)
Query Parameter —
Поисковый запрос.
Поддерживается язык запросов.
Значение по умолчанию: все предложения магазина, размещенные на Маркете.
default: null
feedId (optional)
Query Parameter — Идентификатор прайс-листа. default: null format: int64
shopCategoryId (optional)
Query Parameter —
Идентификатор категории предложения, указанный магазином в прайс-листе.
Параметр выводится только для предложений, у которых указана категория в прайс-листе.
Параметр доступен начиная с версии 2.0 партнерского API.
default: null
currency (optional)
Query Parameter —
Валюта, в которой указана цена предложения.
Возможные значения:
default: null
matched (optional)
Query Parameter —
Фильтр по признаку соотнесения предложения и карточки модели.
Возможные значения:
-
0 / FALSE / NO — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.
-
1 / TRUE / YES — поиск выполняется среди предложений, соотнесенных с карточками моделей).
default: null
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"offers" : [ {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
}, {
"marketCategoryId" : 1,
"preDiscountPrice" : 5.962133916683182,
"shopCategoryId" : "shopCategoryId",
"modelId" : 2,
"fee" : 3.616076749251911,
"discount" : 5,
"url" : "url",
"cbid" : 9.301444243932576,
"blocked" : true,
"feedId" : 6,
"price" : 0.8008281904610115,
"name" : "name",
"currency" : "RUR",
"id" : "id",
"cutPrice" : true,
"bid" : 7.061401241503109
} ],
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Предложения магазина.
GetOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers/update
Изменение условий продажи товаров в магазине (updateCampaignOffers)
Изменяет параметры продажи товаров в конкретном магазине: доступность товара, условия доставки и самовывоза, применяемую ставку НДС.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ 200 обозначает, что новые параметры получены Маркетом и скоро вступят в силу.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/{orderId}/business-buyer
Информация о покупателе — юридическом лице (getOrderBusinessBuyerInfo)
Возвращает информацию о покупателе по идентификатору заказа.
{% note info "" %}
Чтобы получить информацию о покупателе, который является физическим лицом, воспользуйтесь запросом GET campaigns/{campaignId}/orders/{orderId}/buyer.
{% endnote %}
Получить данные можно, только если заказ находится в статусе PROCESSING, DELIVERY, PICKUP или DELIVERED.
Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.
|⚙️ Лимит: 3 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"organizationName" : "organizationName",
"organizationJurAddress" : "organizationJurAddress",
"inn" : "inn",
"kpp" : "kpp"
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о покупателе.
GetBusinessBuyerInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/{orderId}/documents
Информация о документах (getOrderBusinessDocumentsInfo)
Возвращает информацию о документах по идентификатору заказа.
Получить данные можно после того, как заказ перейдет в статус DELIVERED.
Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.
|⚙️ Лимит: 3 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"sf" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"torgTwelve" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"upd" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"ukd" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
},
"ksf" : {
"date" : "2000-01-23",
"number" : "number",
"status" : "READY"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о документах.
GetBusinessDocumentsInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/buyer
Информация о покупателе — физическом лице (getOrderBuyerInfo)
Возвращает информацию о покупателе по идентификатору заказа.
{% note info "" %}
Чтобы получить информацию о покупателе, который является юридическим лицом, воспользуйтесь запросом POST campaigns/{campaignId}/orders/{orderId}/business-buyer.
{% endnote %}
Получить данные можно, только если заказ находится в статусе PROCESSING, DELIVERY или PICKUP.
Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.
|⚙️ Лимит: 3 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"lastName" : "lastName",
"firstName" : "firstName",
"phone" : "phone",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о покупателе.
GetOrderBuyerInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/delivery/date
Изменение даты доставки заказа (setOrderDeliveryDate)
Метод изменяет дату доставки заказа в статусе PROCESSING или DELIVERY. Для заказов с другими статусами дату доставки изменить нельзя.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Успешное изменение даты доставки.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/{orderId}/delivery/track
Передача трек‑номера посылки (setOrderDeliveryTrackCode)
{% note warning "Этот запрос только для DBS" %}
Вы можете использовать запрос, чтобы повысить лояльность покупателей. Если они могут узнать, на каком этапе доставки находятся их заказы, доверие покупателей к вашему магазину может возрасти.
{% endnote %}
Передает Маркету трек‑номер, по которому покупатель может отследить посылку со своим заказом через службу доставки.
Передать трек‑номер можно, только если заказ находится в статусе PROCESSING, DELIVERY или PICKUP.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Трек‑номер посылки и идентификатор службы доставки были успешно переданы.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/delivery/storage-limit
Продление срока хранения заказа (updateOrderStorageLimit)
Продлевает срок хранения заказа в пункте выдачи продавца.
Заказ должен быть в статусе PICKUP. Продлить срок можно только один раз, не больше чем на 30 дней.
Новый срок хранения можно получить в параметре outletStorageLimitDate запроса GET campaigns/{campaignId}/orders/{orderId}.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/verifyEac
Передача кода подтверждения (verifyOrderEac)
Отправляет Маркету код подтверждения для его проверки.
Код подтверждает передачу заказа или невыкупа:
- курьеру — курьер должен назвать магазину код;
- магазину — магазин называет код курьеру.
Если магазин получает невыкупленный заказ, то ему нужно назвать курьеру код из кабинета или приложения.
Если у магазина настроена работа с кодами подтверждения, в запросах POST order/status, PUT campaigns/{campaignId}/orders/{orderId}/status, GET campaigns/{campaignId}/orders, GET campaigns/{campaignId}/orders/{orderId} в параметре delivery, вложенном в order будет возвращаться параметр eacType с типом Enum — тип кода подтверждения для передачи заказа.
Возможные значения: MERCHANT_TO_COURIER — магазин называет код курьеру, COURIER_TO_MERCHANT — курьер называет код магазину.
Параметр eacType возвращается при статусах заказа COURIER_FOUND, COURIER_ARRIVED_TO_SENDER и DELIVERY_SERVICE_UNDELIVERED. Если заказ в других статусах, параметр может отсутствовать.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"verificationResult" : "ACCEPTED",
"attemptsLeft" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Проверка кода выполнена успешно.
VerifyOrderEacResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label
Готовый ярлык‑наклейка для коробки в заказе (generateOrderLabel)
Формирует ярлык‑наклейку для коробки в заказе и возвращает ярлык в PDF‑файле.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор грузоместа. default: null format: int64
boxId (required)
Path Parameter — Идентификатор коробки. default: null format: int64
Query parameters
format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. default: null
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/pdfapplication/json
Responses
200
PDF‑файл с ярлыками для коробки. Файл содержит одну страницу с ярлыком.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/labels
Готовые ярлыки‑наклейки на все коробки в одном заказе (generateOrderLabels)
Возвращает PDF-файл с ярлыками, которые нужно наклеить на коробки перед отгрузкой. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке Маркета для продавцов.
На вход нужно передать идентификатор заказа и один необязательный параметр, который управляет версткой PDF-файла.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Query parameters
format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A6. default: null
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/pdfapplication/json
Responses
200
PDF‑файл с ярлыками на все коробки.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/delivery/labels/data
Данные для самостоятельного изготовления ярлыков (getOrderLabelsData)
Возвращает информацию на ярлыках, которые клеятся на коробки в заказе.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"parcelBoxLabels" : [ {
"supplierName" : "supplierName",
"deliveryServiceId" : "deliveryServiceId",
"orderId" : 1,
"fulfilmentId" : "fulfilmentId",
"orderNum" : "orderNum",
"weight" : "weight",
"url" : "url",
"deliveryServiceName" : "deliveryServiceName",
"deliveryAddress" : "deliveryAddress",
"recipientName" : "recipientName",
"place" : "place",
"shipmentDate" : "shipmentDate",
"boxId" : 5
}, {
"supplierName" : "supplierName",
"deliveryServiceId" : "deliveryServiceId",
"orderId" : 1,
"fulfilmentId" : "fulfilmentId",
"orderNum" : "orderNum",
"weight" : "weight",
"url" : "url",
"deliveryServiceName" : "deliveryServiceName",
"deliveryAddress" : "deliveryAddress",
"recipientName" : "recipientName",
"place" : "place",
"shipmentDate" : "shipmentDate",
"boxId" : 5
} ],
"orderId" : 0,
"placesNumber" : 6,
"url" : "url"
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация для печати ярлыков.
GetOrderLabelsDataResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/cancellation/accept
Отмена заказа покупателем (acceptOrderCancellation)
Подтверждает или отклоняет запрос покупателя на отмену заказа, который передан службе доставки.
Покупатель может отменить заказ в течение его обработки или доставки. Если заказ еще обрабатывается (имеет статус PROCESSING), вам не нужно подтверждать отмену заказа — он будет отменен автоматически.
Если заказ уже передан службе доставки (принимает статус DELIVERY или PICKUP) и пользователь отменил его, вы можете предупредить службу об отмене в течение 48 часов. Если служба доставки узнала об отмене до передачи заказа покупателю, подтвердите отмену с помощью запроса PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept. Если заказ уже доставлен, отклоните отмену с помощью этого же запроса. Тогда у покупателя останется заказ, и деньги за него возвращаться не будут.
Чтобы узнать, какие заказы были отменены в статусе DELIVERY или PICKUP, отправьте запрос GET campaigns/{campaignId}/orders. В его URL добавьте входной параметр onlyWaitingForCancellationApprove=true. Вы также можете узнать об отмененных заказах в кабинете или через почту — на нее придет уведомление об отмене.
Если в течение 48 часов вы не подтвердите или отклоните отмену, заказ будет отменен автоматически.
|⚙️ Лимит: 500 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ на отмену заказа был успешно передан.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}
Информация об одном заказе (getOrder)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"order" : {
"delivery" : {
"dispatchType" : "UNKNOWN",
"address" : {
"country" : "country",
"city" : "city",
"postcode" : "postcode",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"house" : "house",
"subway" : "subway",
"phone" : "phone",
"street" : "street",
"district" : "district",
"recipient" : "recipient",
"entryphone" : "entryphone",
"block" : "block",
"entrance" : "entrance",
"floor" : "floor",
"apartment" : "apartment"
},
"liftType" : "NOT_NEEDED",
"deliveryServiceId" : 6,
"estimated" : true,
"dates" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022",
"fromTime" : "fromTime",
"toTime" : "toTime",
"realDeliveryDate" : "23-09-2022"
},
"type" : "DELIVERY",
"serviceName" : "serviceName",
"shipments" : [ {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
}, {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
} ],
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ],
"courier" : {
"vehicleDescription" : "vehicleDescription",
"phone" : "phone",
"phoneExtension" : "phoneExtension",
"fullName" : "fullName",
"vehicleNumber" : "vehicleNumber"
},
"price" : 5.025004791520295,
"outletStorageLimitDate" : "23-09-2022",
"eacType" : "MERCHANT_TO_COURIER",
"liftPrice" : 8.762042012749001,
"eacCode" : "eacCode",
"id" : "id",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"deliveryPartnerType" : "SHOP",
"outletCode" : "outletCode"
},
"notes" : "notes",
"substatus" : "RESERVATION_EXPIRED",
"deliveryTotal" : 1.4658129805029452,
"buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
"creationDate" : "23-09-2022 09:12:41",
"buyerItemsTotal" : 5.962133916683182,
"paymentType" : "PREPAID",
"buyer" : {
"lastName" : "lastName",
"firstName" : "firstName",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"expiryDate" : "23-09-2022 09:12:41",
"buyerTotalBeforeDiscount" : 7.061401241503109,
"itemsTotal" : 6.027456183070403,
"buyerTotal" : 5.637376656633329,
"subsidies" : [ {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
} ],
"paymentMethod" : "CASH_ON_DELIVERY",
"currency" : "RUR",
"fake" : true,
"id" : 0,
"taxSystem" : "OSN",
"cancelRequested" : true,
"items" : [ {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
}, {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
} ],
"status" : "PLACING",
"updatedAt" : "23-09-2022 09:12:41"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о заказе.
GetOrderResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders
Информация о нескольких заказах (getOrders)
Возвращает информацию о заказах. Запрос можно использовать, чтобы узнать, нет ли новых заказов.
Доступна фильтрация по нескольким характеристикам заказов:
-
дате оформления;
-
статусу;
-
идентификаторам заказов;
-
этапу обработки или причине отмены;
-
типу (настоящий или тестовый);
-
дате отгрузки в службу доставки;
-
дате и времени обновления заказа.
Информация о заказах, доставленных или отмененных больше 30 дней назад, не возвращается. Ее можно получить с помощью запроса информации об отдельном заказе GET campaigns/{campaignId}/orders/{orderId} (если у вас есть идентификатор заказа) или запроса отчета по заказам POST campaigns/{campaignId}/stats/orders.
Максимальный диапазон дат за один запрос к ресурсу — 30 дней. Максимальное количество заказов в выходных данных запроса — 50.
Результаты возвращаются постранично. Для навигации по страницам используйте параметры page_token и limit.
Получить более подробную информацию о покупателе и его номере телефона можно с помощью запроса GET campaigns/{campaignId}/orders/{orderId}/buyer.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
orderIds (optional)
Query Parameter — Фильтрация заказов по идентификаторам.
⚠️ Не используйте это поле одновременно с другими фильтрами. Если вы хотите воспользоваться ими, оставьте поле пустым. default: null format: int64
status (optional)
Query Parameter —
Статус заказа:
-
CANCELLED — заказ отменен.
-
DELIVERED — заказ получен покупателем.
-
DELIVERY — заказ передан в службу доставки.
-
PICKUP — заказ доставлен в пункт самовывоза.
-
PROCESSING — заказ находится в обработке.
-
UNPAID — заказ оформлен, но еще не оплачен (если выбрана оплата при оформлении).
Также могут возвращаться другие значения. Обрабатывать их не требуется.
default: null
substatus (optional)
Query Parameter —
Этап обработки заказа (если он имеет статус PROCESSING) или причина отмены заказа (если он имеет статус CANCELLED).
Возможные значения для заказа в статусе PROCESSING:
STARTED — заказ подтвержден, его можно начать обрабатывать.READY_TO_SHIP — заказ собран и готов к отправке.SHIPPED — заказ передан службе доставки.
Возможные значения для заказа в статусе CANCELLED:
-
DELIVERY_SERVICE_UNDELIVERED — служба доставки не смогла доставить заказ.
-
PROCESSING_EXPIRED — значение более не используется.
-
REPLACING_ORDER — покупатель решил заменить товар другим по собственной инициативе.
-
RESERVATION_EXPIRED — покупатель не завершил оформление зарезервированного заказа в течение 10 минут.
-
RESERVATION_FAILED — Маркет не может продолжить дальнейшую обработку заказа.
-
SHOP_FAILED — магазин не может выполнить заказ.
-
USER_CHANGED_MIND — покупатель отменил заказ по личным причинам.
-
USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут.
-
USER_REFUSED_DELIVERY — покупателя не устроили условия доставки.
-
USER_REFUSED_PRODUCT — покупателю не подошел товар.
-
USER_REFUSED_QUALITY — покупателя не устроило качество товара.
-
USER_UNREACHABLE — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:
- не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
- перерыв между первым и третьим звонком не менее 90 минут;
- соединение не короче 5 секунд.
Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.
-
USER_WANTS_TO_CHANGE_DELIVERY_DATE — покупатель хочет получить заказ в другой день.
-
CANCELLED_COURIER_NOT_FOUND — не удалось найти курьера.
Также могут возвращаться другие значения. Обрабатывать их не требуется.
default: null
fromDate (optional)
Query Parameter —
Начальная дата для фильтрации заказов по дате оформления.
Формат даты: ДД-ММ-ГГГГ.
Между начальной и конечной датой (параметр toDate) должно быть не больше 30 дней.
Значение по умолчанию: 30 дней назад от текущей даты.
default: null format: date
toDate (optional)
Query Parameter —
Конечная дата для фильтрации заказов по дате оформления.
Показываются заказы, созданные до 00:00 указанного дня.
Формат даты: ДД-ММ-ГГГГ.
Между начальной (параметр fromDate) и конечной датой должно быть не больше 30 дней.
Значение по умолчанию: текущая дата.
default: null format: date
supplierShipmentDateFrom (optional)
Query Parameter —
Начальная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).
Формат даты: ДД-ММ-ГГГГ.
Между начальной и конечной датой (параметр supplierShipmentDateTo) должно быть не больше 30 дней.
Начальная дата включается в интервал для фильтрации.
default: null format: date
supplierShipmentDateTo (optional)
Query Parameter —
Конечная дата для фильтрации заказов по дате отгрузки в службу доставки (параметр shipmentDate).
Формат даты: ДД-ММ-ГГГГ.
Между начальной (параметр supplierShipmentDateFrom) и конечной датой должно быть не больше 30 дней.
Конечная дата не включается в интервал для фильтрации.
default: null format: date
updatedAtFrom (optional)
Query Parameter —
Начальная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
Между начальной и конечной датой (параметр updatedAtTo) должно быть не больше 30 дней.
Начальная дата включается в интервал для фильтрации.
default: null format: date-time
updatedAtTo (optional)
Query Parameter —
Конечная дата для фильтрации заказов по дате и времени обновления (параметр updatedAt).
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
Между начальной (параметр updatedAtFrom) и конечной датой должно быть не больше 30 дней.
Конечная дата не включается в интервал для фильтрации.
default: null format: date-time
dispatchType (optional)
Query Parameter — Способ отгрузки default: null
fake (optional)
Query Parameter —
Фильтрация заказов по типам:
default: false
hasCis (optional)
Query Parameter —
Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации в системе «Честный ЗНАК»:
Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.
default: false
onlyWaitingForCancellationApprove (optional)
Query Parameter —
Только для модели DBS
Фильтрация заказов по наличию запросов покупателей на отмену.
При значение true возвращаются только заказы, которые находятся в статусе DELIVERY или PICKUP и которые пользователи решили отменить.
Чтобы подтвердить или отклонить отмену, отправьте запрос PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept.
default: false
onlyEstimatedDelivery (optional)
Query Parameter —
Фильтрация заказов с долгой доставкой (31-60 дней) по подтвержденной дате доставки:
true — возвращаются только заказы с неподтвержденной датой доставки.false — фильтрация не применяется.
default: false
buyerType (optional)
Query Parameter — Фильтрация заказов по типу покупателя. default: null
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
},
"orders" : [ {
"delivery" : {
"dispatchType" : "UNKNOWN",
"address" : {
"country" : "country",
"city" : "city",
"postcode" : "postcode",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"house" : "house",
"subway" : "subway",
"phone" : "phone",
"street" : "street",
"district" : "district",
"recipient" : "recipient",
"entryphone" : "entryphone",
"block" : "block",
"entrance" : "entrance",
"floor" : "floor",
"apartment" : "apartment"
},
"liftType" : "NOT_NEEDED",
"deliveryServiceId" : 6,
"estimated" : true,
"dates" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022",
"fromTime" : "fromTime",
"toTime" : "toTime",
"realDeliveryDate" : "23-09-2022"
},
"type" : "DELIVERY",
"serviceName" : "serviceName",
"shipments" : [ {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
}, {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
} ],
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ],
"courier" : {
"vehicleDescription" : "vehicleDescription",
"phone" : "phone",
"phoneExtension" : "phoneExtension",
"fullName" : "fullName",
"vehicleNumber" : "vehicleNumber"
},
"price" : 5.025004791520295,
"outletStorageLimitDate" : "23-09-2022",
"eacType" : "MERCHANT_TO_COURIER",
"liftPrice" : 8.762042012749001,
"eacCode" : "eacCode",
"id" : "id",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"deliveryPartnerType" : "SHOP",
"outletCode" : "outletCode"
},
"notes" : "notes",
"substatus" : "RESERVATION_EXPIRED",
"deliveryTotal" : 1.4658129805029452,
"buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
"creationDate" : "23-09-2022 09:12:41",
"buyerItemsTotal" : 5.962133916683182,
"paymentType" : "PREPAID",
"buyer" : {
"lastName" : "lastName",
"firstName" : "firstName",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"expiryDate" : "23-09-2022 09:12:41",
"buyerTotalBeforeDiscount" : 7.061401241503109,
"itemsTotal" : 6.027456183070403,
"buyerTotal" : 5.637376656633329,
"subsidies" : [ {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
} ],
"paymentMethod" : "CASH_ON_DELIVERY",
"currency" : "RUR",
"fake" : true,
"id" : 0,
"taxSystem" : "OSN",
"cancelRequested" : true,
"items" : [ {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
}, {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
} ],
"status" : "PLACING",
"updatedAt" : "23-09-2022 09:12:41"
}, {
"delivery" : {
"dispatchType" : "UNKNOWN",
"address" : {
"country" : "country",
"city" : "city",
"postcode" : "postcode",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"house" : "house",
"subway" : "subway",
"phone" : "phone",
"street" : "street",
"district" : "district",
"recipient" : "recipient",
"entryphone" : "entryphone",
"block" : "block",
"entrance" : "entrance",
"floor" : "floor",
"apartment" : "apartment"
},
"liftType" : "NOT_NEEDED",
"deliveryServiceId" : 6,
"estimated" : true,
"dates" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022",
"fromTime" : "fromTime",
"toTime" : "toTime",
"realDeliveryDate" : "23-09-2022"
},
"type" : "DELIVERY",
"serviceName" : "serviceName",
"shipments" : [ {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
}, {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
} ],
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ],
"courier" : {
"vehicleDescription" : "vehicleDescription",
"phone" : "phone",
"phoneExtension" : "phoneExtension",
"fullName" : "fullName",
"vehicleNumber" : "vehicleNumber"
},
"price" : 5.025004791520295,
"outletStorageLimitDate" : "23-09-2022",
"eacType" : "MERCHANT_TO_COURIER",
"liftPrice" : 8.762042012749001,
"eacCode" : "eacCode",
"id" : "id",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"deliveryPartnerType" : "SHOP",
"outletCode" : "outletCode"
},
"notes" : "notes",
"substatus" : "RESERVATION_EXPIRED",
"deliveryTotal" : 1.4658129805029452,
"buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
"creationDate" : "23-09-2022 09:12:41",
"buyerItemsTotal" : 5.962133916683182,
"paymentType" : "PREPAID",
"buyer" : {
"lastName" : "lastName",
"firstName" : "firstName",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"expiryDate" : "23-09-2022 09:12:41",
"buyerTotalBeforeDiscount" : 7.061401241503109,
"itemsTotal" : 6.027456183070403,
"buyerTotal" : 5.637376656633329,
"subsidies" : [ {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
} ],
"paymentMethod" : "CASH_ON_DELIVERY",
"currency" : "RUR",
"fake" : true,
"id" : 0,
"taxSystem" : "OSN",
"cancelRequested" : true,
"items" : [ {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
}, {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
} ],
"status" : "PLACING",
"updatedAt" : "23-09-2022 09:12:41"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о заказах.
GetOrdersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/{orderId}/deliverDigitalGoods
Передача ключей цифровых товаров (provideOrderDigitalCodes)
Передает ключи цифровых товаров, которые покупатель заказал и оплатил. После выполнения запроса Маркет отправит ему письмо с ключами и инструкциями по активации, а также переведет заказ в финальный статус DELIVERED.
Ключ нужно передать в течение 30 минут после перехода заказа в статус PROCESSING.
Если в один заказ входят несколько ключей, передавайте их все в одном запросе.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/identifiers
Передача кодов маркировки единиц товара (provideOrderItemIdentifiers)
{% note warning "Этот запрос только для DBS" %}
Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.
{% endnote %}
Передает Маркету коды маркировки для единиц товара в указанном заказе.
Принимаются коды следующих типов:
- Коды «Честного знака».
- УИН для ювелирных изделий.
- РНПТ и ГТД для импортных прослеживаемых товаров.
{% note warning %}
Прежде чем работать с этим методом, обязательно прочтите статью о работе с маркируемыми товарами.
{% endnote %}
Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"items" : [ {
"offerName" : "offerName",
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"price" : 1.4658129805029452,
"vat" : "NO_VAT",
"count" : 6,
"offerId" : "offerId",
"id" : 0
}, {
"offerName" : "offerName",
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"price" : 1.4658129805029452,
"vat" : "NO_VAT",
"count" : 6,
"offerId" : "offerId",
"id" : 0
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ 200 обозначает, что коды успешно записались. Ответ содержит краткие сведения о промаркированных товарах.
ProvideOrderItemIdentifiersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/boxes
Подготовка заказа (setOrderBoxLayout)
{% note tip "Подходит и для DBS" %}
Запрос предназначен для работы с FBS-заказами, но вы можете использовать его для обработки DBS-заказов, если это удобно.
{% endnote %}
Позволяет выполнить три операции:
- передать Маркету информацию о распределении товаров по коробкам;
- передать Маркету коды маркировки для товаров;
- удалить товар из заказа, если его не оказалось на складе.
Если нужно что-то поправить в переданных данных, просто повторите запрос — это можно делать сколько угодно раз до перевода заказа в статус Готов к отгрузке. ⚠️ Если вы меняете раскладку уже после печати и расклейки ярлыков, не забудье перепечатать их и наклеить заново.
Как передать информацию о распределении товаров
В этом запросе вам нужно передать Маркету список коробок и указать, какие именно товары лежат в каждой из них. Коробки могут быть двух типов:
-
Содержащие товары целиком. Такая коробка может содержать сколько угодно единиц любых товаров.
-
Содержащие часть товара. Такие коробки содержат по одной части одного товара. Например, одна содержит внешний блок кондиционера, а другая — внутренний блок.
⚠️ Одна коробка не может содержать и товары целиком, и части товаров.
Как передавать коды маркировки
Если в заказе есть товары, подлежащие маркировке, в запросе нужно передать соответствующие уникальные коды. Что такое маркировка?
Принимаются коды следующих типов:
- Коды «Честного знака».
- УИН для ювелирных изделий.
- РНПТ и ГТД для импортных прослеживаемых товаров.
Для каждой позиции в заказе, требующей маркировки, нужно передать список кодов — по одному для каждой единицы товара. Например, если в заказе две пары тапочек и одна пара туфель, получится список из двух кодов для первой позиции и список из одного кода для второй.
Если товар едет в нескольких коробках, код маркировки нужно передать для каждой из них.
Как удалить товар из заказа
Чтобы удалить товар из заказа:
- Добавьте в запрос
allowRemove: true.
- Передайте распределение по коробкам без товара, который нужно удалить.
{% note warning "Удаление нельзя отменить" %}
Эта операция необратима: покупатель сразу получит уведомление, а состав заказа изменится.
{% endnote %}
Чтобы удалить позицию целиком, не передавайте соответствующий OrderBoxLayoutItemDTO. Чтобы уменьшить количество товара, передайте уменьшенное значение в поле fullCount.
Нельзя удалить или уменьшить количество товара, если он:
- добавлен по акции;
- составляет 99% стоимости заказа;
- единственный товар в заказе.
Если вы не можете отгрузить такой товар, отмените заказ. Для этого отправьте запрос методом PUT campaigns/{campaignId}/orders/{orderId}/status и передайте статус заказа CANCELLED с причиной отмены SHOP_FAILED.
{% note info "Увеличить заказ нельзя" %}
С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим.
{% endnote %}
Примеры
{% cut "Товар умещается в коробку" %}
Вот как будет выглядеть запрос, если в одной коробке едут:
- три единицы одного товара, требующего маркировки;
- одна единица другого товара, не требущего маркировки.
{
"boxes": [
{
"items": [
{
"id": 123456,
"fullCount": 3,
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
},
{
"cis": "010304109478gftJ14545762!\u001dhGt264"
},
{
"cis": "010304109478fRs28323ks23!\u001dhet201"
}
]
},
{
"id": 654321,
"fullCount": 1
}
]
}
]
}
{% endcut %}
{% cut "Товар едет в разных коробках" %}
Вот как будет выглядеть запрос, если товар едет в двух коробках:
{
"boxes": [
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 2,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
}
]
}
{% endcut %}
{% cut "Одинаковые товары, где каждый едет в нескольких коробках" %}
Вот как будет выглядеть запрос, если каждый из двух одинаковых товаров едет в двух коробках:
{
"boxes": [
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 2,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 2,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
}
]
}
{% endcut %}
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"boxes" : [ {
"items" : [ {
"partialCount" : {
"current" : 1,
"total" : 2
},
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
} ],
"id" : 0,
"fullCount" : 1
}, {
"partialCount" : {
"current" : 1,
"total" : 2
},
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
} ],
"id" : 0,
"fullCount" : 1
} ],
"boxId" : 5
}, {
"items" : [ {
"partialCount" : {
"current" : 1,
"total" : 2
},
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
} ],
"id" : 0,
"fullCount" : 1
}, {
"partialCount" : {
"current" : 1,
"total" : 2
},
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"uin" : "uin",
"cis" : "cis"
} ],
"id" : 0,
"fullCount" : 1
} ],
"boxId" : 5
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ придет переданная раскладка с идентификаторами коробок — они понадобятся для запроса ярлыков.
SetOrderBoxLayoutResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes
Передача количества грузовых мест в заказе (setOrderShipmentBoxes)
{% note warning "Этот запрос только для DBS" %}
Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.
{% endnote %}
Отгружаемый Маркету заказ может не влезть в одну коробку или упаковку — в этом случае получается, что он занимает несколько грузовых мест.
Количество грузовых мест нужно обязательно передавать Маркету, если оно не равно 1. Это делается перед переводом его в статус Готов к отгрузке. Подробно о том, что в какой момент нужно передавать, рассказано в пошаговой инструкции.
Метод устроен немного нестандартно: количество задается длиной массива пустых объектов.
Раньше метод требовал передачи большего количества данных. Запросы, оформленные по старому образцу, работают, но лучше делать по-новому.
{% cut "Как было раньше" %}
Структура тела PUT-запроса:
{
"boxes":
[
{
"fulfilmentId": "{string}",
"weight": {int64},
"width": {int64},
"height": {int64},
"depth": {int64},
"items":
[
{
"id": {int64},
"count": {int32}
},
...
]
},
...
]
}
| Параметр | Тип | Значение |
| ----------- | ----------- | ----------- |
| boxes | | Список грузовых мест. |
Параметры, вложенные в boxes
| Параметр | Тип | Значение |
| ----------- | ----------- | ----------- |
| fulfilmentId | String | Идентификатор грузового места в информационной системе магазина. Сформируйте идентификатор по шаблону: номер заказа на Маркете-номер грузового места. Например, 7206821‑1, 7206821‑2 и т. д. |
| weight | Int64 | Масса брутто грузового места (суммарная масса упаковки и содержимого) в граммах. |
| width | Int64 | Ширина грузового места в сантиметрах. |
| height | Int64 | Высота грузового места в сантиметрах. |
| depth | Int64 | Глубина грузового места в сантиметрах. |
| items | Int64 | Список товаров в грузовом месте. |
Параметры, вложенные в items
| Параметр | Тип | Значение |
| ----------- | ----------- | ----------- |
| id | Int64 | Идентификатор товара в рамках заказа. |
| count | Int32 | Количество единиц товара в грузовом месте. |
{% endcut %}
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
shipmentId (required)
Path Parameter — Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 0
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 0
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Имеет значение только тип ответа. Если ответ
ОК, количество грузомест записано.
SetOrderShipmentBoxesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/items
Удаление товара из заказа или уменьшение числа единиц (updateOrderItems)
{% note warning "Этот запрос только для DBS" %}
Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.
{% endnote %}
Изменяет состав заказа, если позволяет выбранная служба доставки, в случаях:
- покупатель уменьшил количество товара;
- магазин не может поставить все товары в заказе.
Для этого заказ должен находится в статусе "status": "PROCESSING" этапа обработки "substatus": "STARTED". После передачи статуса "substatus": "READY_TO_SHIP" изменить состав невозможно.
Если одинаковых товаров несколько, для уменьшения количества передайте обновленное значение в атрибуте count параметра item.
Чтобы полностью удалить товар из заказа:
- передайте значение
0; или
- не передавайте параметр
item.
Нельзя удалить или уменьшить количество товара, если он:
- добавлен по акции;
- составляет 99% стоимости заказа;
- единственный товар в заказе.
Если необходимо удалить такой товар, отмените заказ. Для этого отправьте запрос методом PUT campaigns/{campaignId}/orders/{orderId}/status и передайте статус заказа CANCELLED с причиной отмены SHOP_FAILED.
{% note info "Увеличить заказ нельзя" %}
С помощью запроса нельзя увеличить количество одинаковых товаров, добавить новые товары в заказ или заменить один товар другим.
{% endnote %}
Возврат денег покупателю
Если покупатель оплатил товар при оформлении, Маркет вернет ему деньги за удаленные из заказа товары в течение двух дней:
-
при оплате банковской картой — с момента, когда магазин переведет заказ в статус SHIPPED;
-
при оплате через Apple Pay или Google Pay — с момента, когда магазин удалит товар из заказа.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Маркет успешно обработал ваш запрос. Выходные данные не ожидаются.
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/orders/{orderId}/status
Изменение статуса одного заказа (updateOrderStatus)
Изменяет статус заказа. Возможные изменения статусов:
- Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "STARTED" нужно перевести в статус "status": "PROCESSING" и этап обработки "substatus": "READY_TO_SHIP".
- Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "STARTED" нужно перевести в статус "status": "CANCELLED" с причиной отмены заказа "substatus": "SHOP_FAILED".
- Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "READY_TO_SHIP" нужно перевести в статус "status": "CANCELLED" с причиной отмены заказа "substatus": "SHOP_FAILED".
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"order" : {
"delivery" : {
"dispatchType" : "UNKNOWN",
"address" : {
"country" : "country",
"city" : "city",
"postcode" : "postcode",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"house" : "house",
"subway" : "subway",
"phone" : "phone",
"street" : "street",
"district" : "district",
"recipient" : "recipient",
"entryphone" : "entryphone",
"block" : "block",
"entrance" : "entrance",
"floor" : "floor",
"apartment" : "apartment"
},
"liftType" : "NOT_NEEDED",
"deliveryServiceId" : 6,
"estimated" : true,
"dates" : {
"fromDate" : "23-09-2022",
"toDate" : "23-09-2022",
"fromTime" : "fromTime",
"toTime" : "toTime",
"realDeliveryDate" : "23-09-2022"
},
"type" : "DELIVERY",
"serviceName" : "serviceName",
"shipments" : [ {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
}, {
"boxes" : [ {
"fulfilmentId" : "fulfilmentId",
"id" : 3
}, {
"fulfilmentId" : "fulfilmentId",
"id" : 3
} ],
"id" : 6,
"shipmentDate" : "23-09-2022",
"shipmentTime" : "shipmentTime",
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ]
} ],
"tracks" : [ {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
}, {
"trackCode" : "trackCode",
"deliveryServiceId" : 9
} ],
"courier" : {
"vehicleDescription" : "vehicleDescription",
"phone" : "phone",
"phoneExtension" : "phoneExtension",
"fullName" : "fullName",
"vehicleNumber" : "vehicleNumber"
},
"price" : 5.025004791520295,
"outletStorageLimitDate" : "23-09-2022",
"eacType" : "MERCHANT_TO_COURIER",
"liftPrice" : 8.762042012749001,
"eacCode" : "eacCode",
"id" : "id",
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"deliveryPartnerType" : "SHOP",
"outletCode" : "outletCode"
},
"notes" : "notes",
"substatus" : "RESERVATION_EXPIRED",
"deliveryTotal" : 1.4658129805029452,
"buyerItemsTotalBeforeDiscount" : 2.3021358869347655,
"creationDate" : "23-09-2022 09:12:41",
"buyerItemsTotal" : 5.962133916683182,
"paymentType" : "PREPAID",
"buyer" : {
"lastName" : "lastName",
"firstName" : "firstName",
"middleName" : "middleName",
"id" : "id",
"type" : "PERSON"
},
"expiryDate" : "23-09-2022 09:12:41",
"buyerTotalBeforeDiscount" : 7.061401241503109,
"itemsTotal" : 6.027456183070403,
"buyerTotal" : 5.637376656633329,
"subsidies" : [ {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 4.965218492984954,
"type" : "YANDEX_CASHBACK"
} ],
"paymentMethod" : "CASH_ON_DELIVERY",
"currency" : "RUR",
"fake" : true,
"id" : 0,
"taxSystem" : "OSN",
"cancelRequested" : true,
"items" : [ {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
}, {
"offerName" : "offerName",
"subsidy" : 1.0246457001441578,
"instances" : [ {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
}, {
"rnpt" : "rnpt",
"gtd" : "gtd",
"cisFull" : "cisFull",
"uin" : "uin",
"cis" : "cis"
} ],
"priceBeforeDiscount" : 7.386281948385884,
"count" : 1,
"vat" : "NO_VAT",
"requiredInstanceTypes" : [ "CIS", "CIS" ],
"buyerPriceBeforeDiscount" : 4.145608029883936,
"shopSku" : "shopSku",
"price" : 3.616076749251911,
"partnerWarehouseId" : "partnerWarehouseId",
"subsidies" : [ {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
}, {
"amount" : 1.1730742509559433,
"type" : "YANDEX_CASHBACK"
} ],
"offerId" : "offerId",
"buyerPrice" : 2.027123023002322,
"details" : [ {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
}, {
"updateDate" : "23-09-2022",
"itemStatus" : "REJECTED",
"itemCount" : 7
} ],
"id" : 9,
"promos" : [ {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
}, {
"subsidy" : 6.84685269835264,
"shopPromoId" : "shopPromoId",
"discount" : 1.4894159098541704,
"marketPromoId" : "marketPromoId",
"type" : "DIRECT_DISCOUNT"
} ]
} ],
"status" : "PLACING",
"updatedAt" : "23-09-2022 09:12:41"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В случае успешного изменения статуса заказа возвращается обновленная информация о заказе.
UpdateOrderStatusResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/status-update
Изменение статусов нескольких заказов (updateOrderStatuses)
Изменяет статусы нескольких заказов.
Возможные изменения статусов:
- Если магазин подтвердил и подготовил заказ к отправке, то заказ из статуса
"status": "PROCESSING"и этапа обработки "substatus": "STARTED" нужно перевести в статус "status": "PROCESSING" и этап обработки "substatus": "READY_TO_SHIP".
- Если магазин подтвердил заказ, но не может его выполнить (например, товар числится в базе, но отсутствует на складе или нет нужного цвета), то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "STARTED" нужно перевести в статус "status": "CANCELLED" с причиной отмены заказа "substatus": "SHOP_FAILED".
- Если магазин подготовил заказ к отгрузке, но не может его выполнить (например, последний товар был поврежден или оказался с браком), то заказ из статуса
"status": "PROCESSING" и этапа обработки "substatus": "READY_TO_SHIP" нужно перевести в статус "status": "CANCELLED" с причиной отмены заказа "substatus": "SHOP_FAILED".
Максимальное количество заказов, у которых можно изменить статус в одном запросе, — 30.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"orders" : [ {
"substatus" : "RESERVATION_EXPIRED",
"updateStatus" : "OK",
"id" : 0,
"status" : "PLACING",
"errorDetails" : "errorDetails"
}, {
"substatus" : "RESERVATION_EXPIRED",
"updateStatus" : "OK",
"id" : 0,
"status" : "PLACING",
"errorDetails" : "errorDetails"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Возвращается информация об обновленных статусах заказов.
UpdateOrderStatusesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/stats/orders
Детальная информация по заказам (getOrdersStats)
Возвращает информацию по заказам на Маркете, в которых есть ваши товары. С помощью нее вы можете собрать статистику по вашим заказам и узнать, например, какие из товаров чаще всего возвращаются покупателями, какие, наоборот, пользуются большим спросом, какая комиссия начисляется за заказы и т. п.
{% note info "" %}
Раньше генерация детальной информации по заказам называлась Отчет по заказам. Сейчас это новый отчет. Подробнее об отчете
{% endnote %}
В одном запросе можно получить информацию не более чем по 200 заказам.
|⚙️ Лимит: 1 000 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"orders" : [ {
"partnerOrderId" : "partnerOrderId",
"commissions" : [ {
"actual" : 1.2315135367772556,
"type" : "FEE"
}, {
"actual" : 1.2315135367772556,
"type" : "FEE"
} ],
"statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
"payments" : [ {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
}, {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
} ],
"fake" : true,
"deliveryRegion" : {
"name" : "name",
"id" : 6
},
"id" : 0,
"creationDate" : "2000-01-23",
"items" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"initialItems" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"status" : "CANCELLED_BEFORE_PROCESSING",
"paymentType" : "CREDIT"
}, {
"partnerOrderId" : "partnerOrderId",
"commissions" : [ {
"actual" : 1.2315135367772556,
"type" : "FEE"
}, {
"actual" : 1.2315135367772556,
"type" : "FEE"
} ],
"statusUpdateDate" : "2000-01-23T04:56:07.000+00:00",
"payments" : [ {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
}, {
"date" : "2000-01-23",
"total" : 7.386281948385884,
"paymentOrder" : {
"date" : "2000-01-23",
"id" : "id"
},
"id" : "id",
"source" : "BUYER",
"type" : "PAYMENT"
} ],
"fake" : true,
"deliveryRegion" : {
"name" : "name",
"id" : 6
},
"id" : 0,
"creationDate" : "2000-01-23",
"items" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"initialItems" : [ {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
}, {
"cofinanceValue" : 4.145608029883936,
"initialCount" : 3,
"offerName" : "offerName",
"shopSku" : "shopSku",
"cisList" : [ "cisList", "cisList" ],
"marketSku" : 1,
"count" : 5,
"bidFee" : 570,
"cofinanceThreshold" : 2.027123023002322,
"details" : [ {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
}, {
"updateDate" : "2000-01-23",
"stockType" : "FIT",
"itemStatus" : "REJECTED",
"itemCount" : 9
} ],
"prices" : [ {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
}, {
"total" : 2.3021358869347655,
"costPerItem" : 5.637376656633329,
"type" : "BUYER"
} ],
"warehouse" : {
"name" : "name",
"id" : 7
}
} ],
"status" : "CANCELLED_BEFORE_PROCESSING",
"paymentType" : "CREDIT"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация по заказам.
GetOrdersStatsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
delete /campaigns/{campaignId}/outlets/licenses
Удаление лицензий для точек продаж (deleteOutletLicenses)
Удаляет информацию о лицензиях для точек продаж.
В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.
|⚙️ Лимит: 100 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
ids (optional)
Query Parameter — Список идентификаторов лицензий. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/outlets/licenses
Информация о лицензиях для точек продаж (getOutletLicenses)
Возвращает информацию о лицензиях для точек продаж.
В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.
|⚙️ Лимит: 100 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
outletIds (optional)
Query Parameter —
Список идентификаторов точек продаж, для которых нужно получить информацию о лицензиях. Идентификаторы указываются через запятую.
В запросе должен быть либо параметр outletIds, либо параметр ids. Запрос с обоими параметрами или без них приведет к ошибке.
default: null format: int64
ids (optional)
Query Parameter — Список идентификаторов лицензий. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"licenses" : [ {
"licenseType" : "ALCOHOL",
"number" : "number",
"dateOfExpiry" : "2000-01-23T04:56:07.000+00:00",
"checkStatus" : "NEW",
"outletId" : 6,
"id" : 0,
"dateOfIssue" : "2000-01-23T04:56:07.000+00:00",
"checkComment" : "checkComment"
}, {
"licenseType" : "ALCOHOL",
"number" : "number",
"dateOfExpiry" : "2000-01-23T04:56:07.000+00:00",
"checkStatus" : "NEW",
"outletId" : 6,
"id" : 0,
"dateOfIssue" : "2000-01-23T04:56:07.000+00:00",
"checkComment" : "checkComment"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Найденные лицензии собственных точек продаж.
GetOutletLicensesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/outlets/licenses
Создание и изменение лицензий для точек продаж (updateOutletLicenses)
Передает информацию о новых и существующих лицензиях для точек продаж. Поддерживаются только лицензии на розничную продажу алкоголя.
Чтобы размещать алкогольную продукцию на Маркете, надо также прислать гарантийное письмо (если вы еще не делали этого раньше) и правильно оформить предложения в прайс-листе. Далее информация о лицензиях проходит проверку.
В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.
|⚙️ Лимит: 100 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/outlets
Создание точки продаж (createOutlet)
Создает точку продаж магазина на Маркете.
В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.
|⚙️ Лимит: 100 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"id" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о созданной точке продаж.
CreateOutletResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
delete /campaigns/{campaignId}/outlets/{outletId}
Удаление точки продаж (deleteOutlet)
Удаляет точку продаж магазина на Маркете.
В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.
|⚙️ Лимит: 100 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
outletId (required)
Path Parameter — Идентификатор точки продаж. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/outlets/{outletId}
Информация об одной точке продаж (getOutlet)
Возвращает информацию о точках продаж магазина.
В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.
|⚙️ Лимит: 100 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
outletId (required)
Path Parameter — Идентификатор точки продаж. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"outlet" : {
"storagePeriod" : 9,
"address" : {
"number" : "number",
"km" : 6,
"regionId" : 0,
"city" : "city",
"street" : "street",
"additional" : "additional",
"estate" : "estate",
"block" : "block",
"building" : "building"
},
"moderationReason" : "moderationReason",
"visibility" : "HIDDEN",
"isMain" : true,
"phones" : [ "phones", "phones" ],
"workingTime" : "workingTime",
"type" : "DEPOT",
"workingSchedule" : {
"scheduleItems" : [ {
"startDay" : "MONDAY",
"startTime" : "startTime",
"endTime" : "endTime"
}, {
"startDay" : "MONDAY",
"startTime" : "startTime",
"endTime" : "endTime"
} ],
"workInHoliday" : true
},
"shopOutletId" : "shopOutletId",
"shopOutletCode" : "shopOutletCode",
"name" : "name",
"id" : 3,
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"coords" : "coords",
"deliveryRules" : [ {
"priceFreePickup" : 7.061401241503109,
"deliveryServiceId" : 5,
"maxDeliveryDays" : 5,
"minDeliveryDays" : 1,
"orderBefore" : 5,
"unspecifiedDeliveryInterval" : true
}, {
"priceFreePickup" : 7.061401241503109,
"deliveryServiceId" : 5,
"maxDeliveryDays" : 5,
"minDeliveryDays" : 1,
"orderBefore" : 5,
"unspecifiedDeliveryInterval" : true
} ],
"status" : "AT_MODERATION"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о точке продаж.
GetOutletResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/outlets
Информация о нескольких точках продаж (getOutlets)
Возвращает список точек продаж магазина.
В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.
|⚙️ Лимит: 100 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
region_id (optional)
Query Parameter — Идентификатор региона.
Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.
Идентификатор региона можно получить c помощью метода
GET regions. default: null format: int64
shop_outlet_code (optional)
Query Parameter — Идентификатор точки продаж, присвоенный магазином. default: null
regionId (optional)
Query Parameter —
{% note warning "" %}
Этот параметр устарел. Для указания региона используйте region_id.
{% endnote %}
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
},
"outlets" : [ {
"storagePeriod" : 9,
"address" : {
"number" : "number",
"km" : 6,
"regionId" : 0,
"city" : "city",
"street" : "street",
"additional" : "additional",
"estate" : "estate",
"block" : "block",
"building" : "building"
},
"moderationReason" : "moderationReason",
"visibility" : "HIDDEN",
"isMain" : true,
"phones" : [ "phones", "phones" ],
"workingTime" : "workingTime",
"type" : "DEPOT",
"workingSchedule" : {
"scheduleItems" : [ {
"startDay" : "MONDAY",
"startTime" : "startTime",
"endTime" : "endTime"
}, {
"startDay" : "MONDAY",
"startTime" : "startTime",
"endTime" : "endTime"
} ],
"workInHoliday" : true
},
"shopOutletId" : "shopOutletId",
"shopOutletCode" : "shopOutletCode",
"name" : "name",
"id" : 3,
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"coords" : "coords",
"deliveryRules" : [ {
"priceFreePickup" : 7.061401241503109,
"deliveryServiceId" : 5,
"maxDeliveryDays" : 5,
"minDeliveryDays" : 1,
"orderBefore" : 5,
"unspecifiedDeliveryInterval" : true
}, {
"priceFreePickup" : 7.061401241503109,
"deliveryServiceId" : 5,
"maxDeliveryDays" : 5,
"minDeliveryDays" : 1,
"orderBefore" : 5,
"unspecifiedDeliveryInterval" : true
} ],
"status" : "AT_MODERATION"
}, {
"storagePeriod" : 9,
"address" : {
"number" : "number",
"km" : 6,
"regionId" : 0,
"city" : "city",
"street" : "street",
"additional" : "additional",
"estate" : "estate",
"block" : "block",
"building" : "building"
},
"moderationReason" : "moderationReason",
"visibility" : "HIDDEN",
"isMain" : true,
"phones" : [ "phones", "phones" ],
"workingTime" : "workingTime",
"type" : "DEPOT",
"workingSchedule" : {
"scheduleItems" : [ {
"startDay" : "MONDAY",
"startTime" : "startTime",
"endTime" : "endTime"
}, {
"startDay" : "MONDAY",
"startTime" : "startTime",
"endTime" : "endTime"
} ],
"workInHoliday" : true
},
"shopOutletId" : "shopOutletId",
"shopOutletCode" : "shopOutletCode",
"name" : "name",
"id" : 3,
"region" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"coords" : "coords",
"deliveryRules" : [ {
"priceFreePickup" : 7.061401241503109,
"deliveryServiceId" : 5,
"maxDeliveryDays" : 5,
"minDeliveryDays" : 1,
"orderBefore" : 5,
"unspecifiedDeliveryInterval" : true
}, {
"priceFreePickup" : 7.061401241503109,
"deliveryServiceId" : 5,
"maxDeliveryDays" : 5,
"minDeliveryDays" : 1,
"orderBefore" : 5,
"unspecifiedDeliveryInterval" : true
} ],
"status" : "AT_MODERATION"
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о точках продаж.
GetOutletsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/outlets/{outletId}
Изменение информации о точке продаж (updateOutlet)
Изменяет информацию о точке продаж магазина на Маркете.
В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.
|⚙️ Лимит: 100 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
outletId (required)
Path Parameter — Идентификатор точки продаж. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/price-quarantine/confirm
Удаление товара из карантина по цене в кабинете (confirmBusinessPrices)
Подтверждает основную цену на товары, которые попали в карантин, и удаляет их из карантина.
Основная цена задается в каталоге и действует во всех магазинах кабинета.
Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин
Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST businesses/{businessId}/price-quarantine.
|⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ 200 обозначает, что цены подтверждены.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/price-quarantine/confirm
Удаление товара из карантина по цене в магазине (confirmCampaignPrices)
Подтверждает в заданном магазине цену на товары, которые попали в карантин, и удаляет их из карантина.
Товар попадает в карантин, если его цена меняется слишком резко. Как настроить карантин
Чтобы увидеть список товаров, которые попали в карантин, используйте запрос POST campaigns/{campaignId}/price-quarantine.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Ответ 200 обозначает, что цены подтверждены.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/price-quarantine
Список товаров, находящихся в карантине по цене в кабинете (getBusinessQuarantineOffers)
Возвращает список товаров, которые находятся в карантине по основной цене. Основная цена задается в каталоге и действует во всех магазинах кабинета.
Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST businesses/{businessId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST businesses/{businessId}/offer-prices/updates.
{% note info "𝓠 Что такое карантин?" %}
𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее
{% endnote %}
В запросе можно использовать фильтры.
Результаты возвращаются постранично.
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
}, {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров в карантине.
GetQuarantineOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/price-quarantine
Список товаров, находящихся в карантине по цене в магазине (getCampaignQuarantineOffers)
Возвращает список товаров, которые находятся в карантине по цене, установленной в заданном магазине.
Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST campaigns/{campaignId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST campaigns/{campaignId}/offer-prices/updates.
{% note info "𝓠 Что такое карантин?" %}
𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее
{% endnote %}
В запросе можно использовать фильтры.
Результаты возвращаются постранично.
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
}, {
"verdicts" : [ {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
}, {
"type" : "PRICE_CHANGE",
"params" : [ {
"name" : "CURRENT_PRICE",
"value" : "value"
}, {
"name" : "CURRENT_PRICE",
"value" : "value"
} ]
} ],
"offerId" : "offerId",
"currentPrice" : {
"value" : 0.9301444243932576
},
"lastValidPrice" : {
"value" : 0.9301444243932576
}
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров в карантине.
GetQuarantineOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/offer-prices
Список цен (getPrices)
{% note warning "" %}
Этот метод устарел. Вместо него используйте POST campaigns/{campaignId}/offer-prices.
{% endnote %}
Возвращает список цен, установленных вами на товары любым способом: например, через партнерский API или в файле с каталогом.
{% note info %}
Общее количество товаров считается по данным за последние семь дней (не включая сегодня) и не может быть выше 2 миллионов.
{% endnote %}
Способы установки цен описаны в Справке Маркета для продавцов.
|⚙️ Лимит: (количество товаров партнера на витрине) * 25 товаров в сутки|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
archived (optional)
Query Parameter — Фильтр по нахождению в архиве. default: false
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"marketSku" : 0,
"id" : "id",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"marketSku" : 0,
"id" : "id",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"total" : 6,
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список всех товаров с установленными ценами.
GetPricesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-prices
Просмотр цен на указанные товары в магазине (getPricesByOfferIds)
Возвращает список цен на указанные товары в магазине.
{% note warning "Метод только для отдельных магазинов" %}
Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.
Для просмотра базовых цен используйте POST businesses/{businessId}/offer-mappings.
{% endnote %}
|⚙️ Лимит: рассчитывается по формуле|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"offerId" : "offerId",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"price" : {
"vat" : 1,
"discountBase" : 6.027456183070403,
"currencyId" : "RUR",
"value" : 0.8008281904610115
},
"offerId" : "offerId",
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров с установленными для заданного магазина ценами.
GetPricesByOfferIdsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-prices/suggestions
Цены для продвижения товаров (getSuggestedPrices)
{% note warning "" %}
Этот метод устарел. Вместо него используйте отчет «Цены на рынке».
{% endnote %}
{% note warning "" %}
Этот метод подходит только тем магазинам, которые устанавливают цены на товары в рублях.
{% endnote %}
Возвращает цены для продвижения товаров, которые вы размещаете на Маркете.
Товары, для которых нужно получить цены, передаются в теле POST-запроса.
Цены для продвижения зависят от цен, установленных на товары другими партнерами. Если один товар поставляют несколько партнеров, на Маркете сначала продается товар с более низкой ценой. Когда закончится товар по низкой цене, начнет продаваться товар по более высокой цене.
Выходные данные содержат для каждого товара несколько цен, соответствующих разным типам продвижения.
Установить цены на товары можно с помощью запроса POST campaigns/{campaignId}/offer-prices/updates или другими способами: например, указать их в файле с каталогом. Также вы можете использовать стратегии для автоматической установки рекомендованных цен или минимальных цен на Маркете.
Подробно об автоматическом управлении ценами рассказано в Справке Маркета для продавцов.
|⚙️ Лимит: 100 000 товаров в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"marketSku" : 0,
"offerId" : "offerId",
"priceSuggestion" : [ {
"price" : 6.027456183070403,
"type" : "BUYBOX"
}, {
"price" : 6.027456183070403,
"type" : "BUYBOX"
} ]
}, {
"marketSku" : 0,
"offerId" : "offerId",
"priceSuggestion" : [ {
"price" : 6.027456183070403,
"type" : "BUYBOX"
}, {
"price" : 6.027456183070403,
"type" : "BUYBOX"
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список цен для продвижения на Маркете.
SuggestPricesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/offer-prices/updates
Установка цен на товары во всех магазинах (updateBusinessPrices)
Устанавливает базовые цены. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Маркет принял информацию о новых ценах.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offer-prices/updates
Установка цен на товары в конкретном магазине (updatePrices)
Устанавливает цены на товары в магазине. Чтобы получить рекомендации Маркета, касающиеся цен, выполните запрос POST businesses/{businessId}/offers/recommendations.
{% note warning "Метод только для отдельных магазинов" %}
Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.
Для управления базовыми ценами используйте POST businesses/{businessId}/offer-prices/updates.
{% endnote %}
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 5000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Маркет принял информацию о новых ценах.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
423
К ресурсу нельзя применить указанный метод.
ApiLockedErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos/offers/delete
Удаление товаров из акции (deletePromoOffers)
Убирает товары из акции.
Изменения начинают действовать в течение 4–6 часов.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"rejectedOffers" : [ {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
}, {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Результат удаления товаров из акции.
DeletePromoOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos/offers
Получение списка товаров, которые участвуют или могут участвовать в акции (getPromoOffers)
Возвращает список товаров, которые участвуют или могут участвовать в акции.
{% note warning %}
В параметре limit не передавайте значение больше 500.
{% endnote %}
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"offerId" : "offerId",
"params" : {
"discountParams" : {
"promoPrice" : 6,
"maxPromoPrice" : 1,
"price" : 0
},
"promocodeParams" : {
"maxPrice" : 5
}
},
"status" : "AUTO",
"autoParticipatingDetails" : {
"campaignIds" : [ 5, 5 ]
}
}, {
"offerId" : "offerId",
"params" : {
"discountParams" : {
"promoPrice" : 6,
"maxPromoPrice" : 1,
"price" : 0
},
"promocodeParams" : {
"maxPrice" : 5
}
},
"status" : "AUTO",
"autoParticipatingDetails" : {
"campaignIds" : [ 5, 5 ]
}
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список товаров, которые участвуют или могут участвовать в акции.
GetPromoOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos
Получение списка акций (getPromos)
Возвращает информацию об акциях Маркета.
По умолчанию возвращаются акции, в которых продавец участвует или может принять участие.
Чтобы получить текущие или завершенные акции, передайте параметр participation.
Типы акций, которые возвращаются в ответе:
- прямая скидка;
- флеш-акция;
- скидка по промокоду.
|⚙️ Лимит: 1000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"promos" : [ {
"period" : {
"dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
"dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
},
"channels" : [ "{}", "{}" ],
"mechanicsInfo" : {
"promocodeInfo" : {
"promocode" : "promocode",
"discount" : 1
},
"type" : "DIRECT_DISCOUNT"
},
"bestsellerInfo" : {
"bestseller" : true,
"entryDeadline" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "name",
"participating" : true,
"id" : "id",
"constraints" : {
"warehouseIds" : [ 5, 5 ]
},
"assortmentInfo" : {
"activeOffers" : 0,
"processing" : true,
"potentialOffers" : 6
}
}, {
"period" : {
"dateTimeFrom" : "2000-01-23T04:56:07.000+00:00",
"dateTimeTo" : "2000-01-23T04:56:07.000+00:00"
},
"channels" : [ "{}", "{}" ],
"mechanicsInfo" : {
"promocodeInfo" : {
"promocode" : "promocode",
"discount" : 1
},
"type" : "DIRECT_DISCOUNT"
},
"bestsellerInfo" : {
"bestseller" : true,
"entryDeadline" : "2000-01-23T04:56:07.000+00:00"
},
"name" : "name",
"participating" : true,
"id" : "id",
"constraints" : {
"warehouseIds" : [ 5, 5 ]
},
"assortmentInfo" : {
"activeOffers" : 0,
"processing" : true,
"potentialOffers" : 6
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список акций Маркета.
GetPromosResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/promos/offers/update
Добавление товаров в акцию или изменение их цен (updatePromoOffers)
Добавляет товары в акцию или изменяет цены на товары, которые участвуют в акции.
Изменения начинают действовать в течение 4–6 часов.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"rejectedOffers" : [ {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
}, {
"reason" : "OFFER_DOES_NOT_EXIST",
"offerId" : "offerId"
} ],
"warningOffers" : [ {
"warnings" : [ {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
}, {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
} ],
"offerId" : "offerId"
}, {
"warnings" : [ {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
}, {
"code" : "DEEP_DISCOUNT_OFFER",
"campaignIds" : [ 0, 0 ]
} ],
"offerId" : "offerId"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Результат добавления товаров в акцию или обновления их цен.
UpdatePromoOffersResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/ratings/quality/details
Заказы, которые повлияли на индекс качества (getQualityRatingDetails)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"affectedOrders" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"orderId" : 0,
"description" : "description"
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"orderId" : 0,
"description" : "description"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация о заказах, которые повлияли на индекс качества.
GetQualityRatingDetailsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /businesses/{businessId}/ratings/quality
Индекс качества магазинов (getQualityRatings)
Возвращает значение индекса качества магазинов и его составляющие.
Подробнее об индексе качества читайте в Справке Маркета для продавцов.
|⚙️ Лимит: 10000 запросов в час|
|-|
Path parameters
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"campaignRatings" : [ {
"campaignId" : 0,
"ratings" : [ {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
}, {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
} ]
}, {
"campaignId" : 0,
"ratings" : [ {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
}, {
"components" : [ {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
}, {
"componentType" : "DBS_CANCELLATION_RATE",
"value" : 14.658129805029452
} ],
"rating" : 60,
"calculationDate" : "2000-01-23"
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Значение индекса качества магазинов и его составляющие.
GetQualityRatingResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /regions/{regionId}/children
Информация о дочерних регионах (searchRegionChildren)
Возвращает информацию о регионах, являющихся дочерними по отношению к региону, идентификатор которого указан в запросе.
Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).
Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.
|⚙️ Лимит: 50 000 запросов в час|
|-|
Path parameters
regionId (required)
Path Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
Query parameters
page (optional)
Query Parameter —
Номер страницы результатов.
Значение по умолчанию: 1.
Используется вместе с параметром page_size.
page_number игнорируется, если задан page_token, limit или offset.
default: 1 format: int32
pageSize (optional)
Query Parameter —
Размер страницы.
Используется вместе с параметром page_number.
page_size игнорируется, если задан page_token, limit или offset.
default: null format: int32
Return type
Example data
Content-Type: application/json
{
"regions" : {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
},
"pager" : {
"total" : 1,
"pagesCount" : 7,
"pageSize" : 9,
"from" : 5,
"to" : 5,
"currentPage" : 2
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Регионы, являющиеся дочерними к указанному в запросе.
GetRegionWithChildrenResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /regions/{regionId}
Информация о регионе (searchRegionsById)
Возвращает информацию о регионе.
Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).
Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.
|⚙️ Лимит: 50 000 запросов в час|
|-|
Path parameters
regionId (required)
Path Parameter —
Идентификатор региона.
Идентификатор региона можно получить c помощью запроса GET regions.
default: null format: int64
Return type
Example data
Content-Type: application/json
{
"regions" : [ {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}, {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Найденный регион.
GetRegionsResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Поиск регионов по их имени (searchRegionsByName)
Возвращает информацию о регионе, удовлетворяющем заданным в запросе условиям поиска.
Если найдено несколько регионов, удовлетворяющих условиям поиска, возвращается информация по каждому найденному региону (но не более десяти регионов) для возможности определения нужного региона по родительским регионам.
Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).
Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.
|⚙️ Лимит: 50 000 запросов в час|
|-|
Query parameters
name (required)
Query Parameter —
Название региона.
Важно учитывать регистр: первая буква должна быть заглавной, остальные — строчными. Например, Москва.
default: null
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"regions" : [ {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
}, {
"children" : [ null, null ],
"name" : "name",
"id" : 0,
"type" : "OTHER"
} ],
"paging" : {
"nextPageToken" : "nextPageToken"
}
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список найденных регионов.
GetRegionsResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/boost-consolidated/generate
Отчет по бусту продаж (generateBoostConsolidatedReport)
Запускает генерацию сводного отчета по бусту продаж за заданный период. Отчет содержит информацию по всем кампаниям, созданным и через API, и в кабинете.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/competitors-position/generate
Отчет «Конкурентная позиция» (generateCompetitorsPositionReport)
Запускает генерацию отчета «Конкурентная позиция» за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
{% note info "Значение -1 в отчете" %}
Если в CSV-файле в столбце POSITION стоит -1, в этот день не было заказов с товарами в указанной категории.
{% endnote %}
|⚙️ Лимит: 10 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/goods-feedback/generate
Отчет по отзывам о товарах (generateGoodsFeedbackReport)
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/goods-movement/generate
Отчет по движению товаров (generateGoodsMovementReport)
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/goods-realization/generate
Отчет по реализации (generateGoodsRealizationReport)
Запускает генерацию отчета по реализации за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/goods-turnover/generate
Отчет по оборачиваемости (generateGoodsTurnoverReport)
Запускает генерацию отчета по оборачиваемости за заданную дату. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/documents/labels/generate
Готовые ярлыки‑наклейки на все коробки в нескольких заказах (generateMassOrderLabelsReport)
Запускает генерацию PDF-файла с ярлыками для переданных заказов. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке Маркета для продавцов.
Узнать статус генерации и получить ссылку на готовый файл можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 1000 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый файл.
Если при генерации не удалось найти часть заказов, в ответе на запрос получения готового файла вернется подстатус RESOURCE_NOT_FOUND.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/prices/generate
Отчет «Цены на рынке» (generatePricesReport)
Запускает генерацию отчета «Цены на рынке».
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/shelf-statistics/generate
Отчет по полкам (generateShelfsStatisticsReport)
Запускает генерацию сводного отчета по полкам — рекламным блокам с баннером или видео и набором товаров. Подробнее о них читайте в Справке Маркета для продавцов.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/documents/shipment-list/generate
Получение листа сборки (generateShipmentListDocumentReport)
Запускает генерацию листа сборки для отгрузки.
Узнать статус генерации и получить ссылку на готовый документ можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый документ.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/shows-sales/generate
Отчет «Аналитика продаж» (generateShowsSalesReport)
Запускает генерацию отчета «Аналитика продаж» за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 10 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/stocks-on-warehouses/generate
Отчет по остаткам на складах (generateStocksOnWarehousesReport)
Запускает генерацию отчета по остаткам на складах. Отчет содержит данные:
- Для модели FBY — об остатках на складах Маркета.
- Для остальных моделей — об остатках на соответствующем складе магазина.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/united-marketplace-services/generate
Отчет по стоимости услуг (generateUnitedMarketplaceServicesReport)
Запускает генерацию отчета по стоимости услуг за заданный период. Что это за отчет
Тип отчета зависит от того, какие поля заполнены в запросе:
|Тип отчета |Какие поля нужны |
|-----------------------------|---------------------------------|
|По дате начисления услуги |dateFrom и dateTo |
|По дате формирования акта |year и month |
Заказать отчеты обоих типов одним запросом нельзя.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/united-netting/generate
Отчет по платежам (generateUnitedNettingReport)
Запускает генерацию отчета по платежам за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
Тип отчета зависит от того, какие поля заполнены в запросе:
|Тип отчета |Какие поля нужны |
|-------------------------|---------------------------------------|
|О платежах за период |dateFrom и dateTo |
|О платежном поручении |bankOrderId и bankOrderDateTime |
Заказать отчеты обоих типов одним запросом нельзя.
|⚙️ Лимит: 100 запросов в час|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /reports/united-orders/generate
Отчет по заказам (generateUnitedOrdersReport)
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
format (optional)
Query Parameter — Формат отчета. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"reportId" : "reportId",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
GenerateReportResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /reports/info/{reportId}
Получение заданного отчета (getReportInfo)
Возвращает статус генерации заданного отчета и, если отчет готов, ссылку для скачивания.
Чтобы воспользоваться этим запросом, вначале нужно запустить генерацию отчета. Инструкция
|⚙️ Лимит: 100 запросов в минуту|
|-|
Path parameters
reportId (required)
Path Parameter — Идентификатор отчета, который вы получили после запуска генерации. default: null
Return type
Example data
Content-Type: application/json
{
"result" : {
"generationRequestedAt" : "2000-01-23T04:56:07.000+00:00",
"file" : "file",
"generationFinishedAt" : "2000-01-23T04:56:07.000+00:00",
"subStatus" : "NO_DATA",
"status" : "PENDING",
"estimatedGenerationTime" : 0
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Статус генерации отчета и ссылка, если она уже есть.
{% note tip %}
Если статус генерации отчета — FAILED или NO_DATA, проверьте корректность запроса на генерацию. Например, верно ли указан идентификатор магазина, период или номер платежного поручения.
{% endnote %}
GetReportInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}
Информация о невыкупе или возврате (getReturn)
Получает информацию по одному невыкупу или возврату.
|⚙️ Лимит: 10 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"updateDate" : "2000-01-23T04:56:07.000+00:00",
"fastReturn" : true,
"orderId" : 6,
"shipmentRecipientType" : "SHOP",
"refundStatus" : "STARTED_BY_USER",
"logisticPickupPoint" : {
"logisticPartnerId" : 5,
"address" : {
"country" : "Россия",
"city" : "Москва",
"street" : "Стрелецкая улица",
"postcode" : "123518",
"house" : "9к2"
},
"instruction" : "instruction",
"name" : "name",
"id" : 1,
"type" : "WAREHOUSE"
},
"id" : 0,
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"items" : [ {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
}, {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
} ],
"returnType" : "UNREDEEMED",
"shipmentStatus" : "CREATED",
"refundAmount" : 5
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Детали возврата.
GetReturnResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/application
Получение заявления на возврат (getReturnApplication)
Загружает заявление покупателя на возврат товара.
|⚙️ Лимит: 10 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/octet-streamapplication/json
Responses
200
Заявление на возврат.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/{itemId}/image/{imageHash}
Получение фотографии возврата (getReturnPhoto)
Получает фотографии, которые покупатель приложил к заявлению на возврат товара.
|⚙️ Лимит: 10 000 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
itemId (required)
Path Parameter — Идентификатор товара в возврате. default: null format: int64
imageHash (required)
Path Parameter — Хеш ссылки изображения для загрузки. default: null
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/octet-streamapplication/json
Responses
200
Фотография возврата.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/returns
Список невыкупов и возвратов (getReturns)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
orderIds (optional)
Query Parameter —
Идентификаторы заказов — для фильтрации результатов.
Несколько идентификаторов перечисляются через запятую без пробела. Максимальное количество идентификаторов — 50.
default: null format: int64
statuses (optional)
Query Parameter —
Статусы возвратов или невыкупов — для фильтрации результатов.
Несколько статусов перечисляются через запятую.
default: null
type (optional)
Query Parameter —
Тип заказа для фильтрации:
-
RETURN — возврат.
-
UNREDEEMED — невыкуп.
Если не указывать, в ответе будут и возвраты, и невыкупы.
default: null
fromDate (optional)
Query Parameter —
Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
Формат: ГГГГ-ММ-ДД.
default: null format: date
toDate (optional)
Query Parameter —
Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
Формат: ГГГГ-ММ-ДД.
default: null format: date
from_date (optional)
Query Parameter —
{% note warning "" %}
Этот параметр устарел. Вместо него используйте fromDate.
{% endnote %}
Начальная дата для фильтрации возвратов или невыкупов по дате обновления.
default: null format: date
to_date (optional)
Query Parameter —
{% note warning "" %}
Этот параметр устарел. Вместо него используйте toDate.
{% endnote %}
Конечная дата для фильтрации возвратов или невыкупов по дате обновления.
default: null format: date
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"nextPageToken" : "nextPageToken"
},
"returns" : [ {
"updateDate" : "2000-01-23T04:56:07.000+00:00",
"fastReturn" : true,
"orderId" : 6,
"shipmentRecipientType" : "SHOP",
"refundStatus" : "STARTED_BY_USER",
"logisticPickupPoint" : {
"logisticPartnerId" : 5,
"address" : {
"country" : "Россия",
"city" : "Москва",
"street" : "Стрелецкая улица",
"postcode" : "123518",
"house" : "9к2"
},
"instruction" : "instruction",
"name" : "name",
"id" : 1,
"type" : "WAREHOUSE"
},
"id" : 0,
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"items" : [ {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
}, {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
} ],
"returnType" : "UNREDEEMED",
"shipmentStatus" : "CREATED",
"refundAmount" : 5
}, {
"updateDate" : "2000-01-23T04:56:07.000+00:00",
"fastReturn" : true,
"orderId" : 6,
"shipmentRecipientType" : "SHOP",
"refundStatus" : "STARTED_BY_USER",
"logisticPickupPoint" : {
"logisticPartnerId" : 5,
"address" : {
"country" : "Россия",
"city" : "Москва",
"street" : "Стрелецкая улица",
"postcode" : "123518",
"house" : "9к2"
},
"instruction" : "instruction",
"name" : "name",
"id" : 1,
"type" : "WAREHOUSE"
},
"id" : 0,
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"items" : [ {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
}, {
"shopSku" : "shopSku",
"instances" : [ {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
}, {
"stockType" : "FIT",
"imei" : "imei",
"cis" : "cis",
"status" : "CREATED"
} ],
"marketSku" : 2,
"count" : 7,
"decisions" : [ {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
}, {
"images" : [ "images", "images" ],
"returnItemId" : 9,
"subreasonType" : "USER_DID_NOT_LIKE",
"count" : 3,
"comment" : "comment",
"decisionType" : "REFUND_MONEY",
"reasonType" : "BAD_QUALITY",
"partnerCompensation" : 4,
"refundAmount" : 2
} ],
"tracks" : [ {
"trackCode" : "trackCode"
}, {
"trackCode" : "trackCode"
} ]
} ],
"returnType" : "UNREDEEMED",
"shipmentStatus" : "CREATED",
"refundAmount" : 5
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Постраничные возвраты партнера.
GetReturnsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision
Принятие или изменение решения по возврату (setReturnDecision)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Детали возврата.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/orders/{orderId}/returns/{returnId}/decision/submit
Подтверждение решения по возврату (submitReturnDecision)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
orderId (required)
Path Parameter — Идентификатор заказа. default: null format: int64
returnId (required)
Path Parameter — Идентификатор возврата. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Статус выполнения операции.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/confirm
Подтверждение отгрузки (confirmShipment)
Подтверждает отгрузку товаров в сортировочный центр или пункт приема заказов.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/act
Получение акта приема-передачи (downloadShipmentAct)
{% note warning "Экспресс‑доставка" %}
Если ваш магазин подключен к экспресс‑доставке и вы отгружаете заказы курьерам Яндекс Go, подготавливать акт приема‑передачи не нужно.
{% endnote %}
Запрос формирует акт приема-передачи заказов, входящих в отгрузку, и возвращает акт в формате PDF. В акте содержатся собранные и готовые к отправке заказы.
При формировании акта Маркет автоматически находит и подставляет в шаблон следующие данные:
{% cut "Данные, из которых Маркет формирует акт" %}
| Данные в акте | Описание |
| --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Дата | Дата запроса. |
| Отправитель | Название вашего юридического лица, указанное в кабинете продавца на Маркете. |
| Исполнитель | Название юридического лица сортировочного центра или службы доставки. |
| № отправления в системе заказчика | Ваш идентификатор заказа, который вы указали в ответе на запрос POST order/accept от Маркета. |
| № отправления в системе исполнителя (субподрядчика) | Идентификатор заказа на Маркете, как в выходных данных запроса GET campaigns/{campaignId}/orders. |
| Объявленная ценность | Общая сумма заказа без учета стоимости доставки, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. |
| Вес | Масса брутто грузового места (суммарная масса упаковки и содержимого), как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. |
| Количество мест | Количество грузовых мест в заказе, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. |
{% endcut %}
Остальные поля нужно заполнить самостоятельно в распечатанном акте.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/pdfapplication/json
Responses
200
Акт приема-передачи для отгрузки в формате PDF.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/discrepancy-act
Получение акта расхождений (downloadShipmentDiscrepancyAct)
Возвращает акт расхождений для заданной отгрузки.
|⚙️ Лимит: 200 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.ms-excelapplication/json
Responses
200
Акт расхождений в формате XLSX.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/inbound-act
Получение фактического акта приема-передачи (downloadShipmentInboundAct)
Возвращает фактический акт приема-передачи для заданной отгрузки.
Такой акт становится доступен спустя несколько часов после завершения отгрузки. Он может понадобиться, если после отгрузки обнаружатся расхождения.
|⚙️ Лимит: 200 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/pdfapplication/json
Responses
200
Акт в формате PDF.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallet/labels
Ярлыки для доверительной приемки (FBS) (downloadShipmentPalletLabels)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Query parameters
format (optional)
Query Parameter —
Формат страниц PDF-файла с ярлыками:
A4 — по 16 ярлыков на странице.A8 — по одному ярлыку на странице.
default: null
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/pdfapplication/json
Responses
200
PDF‑файл с ярлыками на все упаковки в отгрузке.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/shipments/reception-transfer-act
Подтверждение ближайшей отгрузки и получение акта приема-передачи для нее (downloadShipmentReceptionTransferAct)
Запрос подтверждает ближайшую отгрузку и возвращает акт приема-передачи в формате PDF.
{% note warning "Экспресс‑доставка" %}
Если ваш магазин подключен к экспресс‑доставке и вы отгружаете заказы курьерам Яндекс Go, подготавливать акт приема‑передачи не нужно.
{% endnote %}
В акт входят собранные и готовые к отправке заказы, которые отгружаются в сортировочный центр или пункт приема или курьерам Маркета.
При формировании акта Маркет автоматически находит и подставляет в шаблон следующие данные:
{% cut "Данные, из которых Маркет формирует акт" %}
| Данные в акте | Описание |
| --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Отправитель | Название вашего юридического лица, указанное в кабинете продавца на Маркете. |
| Исполнитель | Название юридического лица сортировочного центра или службы доставки. |
| № отправления в системе заказчика | Ваш идентификатор заказа, который вы указали в ответе на запрос POST order/accept от Маркета. |
| № отправления в системе исполнителя (субподрядчика) | Идентификатор заказа на Маркете, как в выходных данных запроса GET campaigns/{campaignId}/orders. |
| Объявленная ценность | Общая сумма заказа без учета стоимости доставки, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. |
| Стоимость всех товаров в заказе | Стоимость всех заказанных товаров. |
| Вес | Масса брутто грузового места (суммарная масса упаковки и содержимого), как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. |
| Количество мест | Количество грузовых мест в заказе, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}. |
{% endcut %}
Остальные поля нужно заполнить самостоятельно в распечатанном акте.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Query parameters
warehouse_id (optional)
Query Parameter — Идентификатор склада. default: null format: int32
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/pdfapplication/json
Responses
200
Акт приема-передачи в формате PDF.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/transportation-waybill
Получение транспортной накладной (downloadShipmentTransportationWaybill)
Возвращает транспортную накладную для заданной отгрузки.
Транспортная накладная понадобится, если вы отгружаете товары непосредственно со своего склада. Подробно об этом способе отгрузки
|⚙️ Лимит: 200 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Return type
File
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/vnd.ms-excelapplication/json
Responses
200
Транспортная накладная в формате XLSX.
File
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}
Получение информации об одной отгрузке (getShipment)
Возвращает информацию об отгрузке по ее идентификатору.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Query parameters
cancelledOrders (optional)
Query Parameter —
Возвращать ли отмененные заказы.
Значение по умолчанию — true. Если возвращать отмененные заказы не нужно, передайте значение false.
default: true
Return type
Example data
Content-Type: application/json
{
"result" : {
"deliveryService" : {
"name" : "name",
"id" : 1
},
"availableActions" : [ "CONFIRM", "CONFIRM" ],
"draftCount" : 7,
"plannedCount" : 9,
"currentStatus" : {
"description" : "description",
"updateTime" : "2000-01-23T04:56:07.000+00:00",
"status" : "OUTBOUND_CREATED"
},
"planIntervalTo" : "2000-01-23T04:56:07.000+00:00",
"externalId" : "externalId",
"warehouse" : {
"address" : "address",
"name" : "name",
"id" : 6
},
"shipmentType" : "IMPORT",
"planIntervalFrom" : "2000-01-23T04:56:07.000+00:00",
"warehouseTo" : {
"address" : "address",
"name" : "name",
"id" : 6
},
"factCount" : 3,
"palletsCount" : {
"fact" : 5,
"planned" : 5
},
"id" : 0,
"orderIds" : [ 2, 2 ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Найденная отгрузка.
GetShipmentResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/info
Получение информации о возможности печати ярлыков (FBS) (getShipmentOrdersInfo)
Возвращает информацию о возможности печати ярлыков-наклеек для заказов в отгрузке.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Return type
Example data
Content-Type: application/json
{
"result" : {
"orderIdsWithLabels" : [ 0, 0 ],
"orderIdsWithoutLabels" : [ 6, 6 ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Информация по годным/негодным для печати ярлыков заказам в отгрузке.
GetShipmentOrdersInfoResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/first-mile/shipments
Получение информации о нескольких отгрузках (searchShipments)
Возвращает информацию об отгрузках по заданным параметрам:
- дате;
- статусу;
- идентификаторам заказов.
Результаты возвращаются постранично.
|⚙️ Лимит: 100 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"paging" : {
"nextPageToken" : "nextPageToken"
},
"shipments" : [ {
"deliveryService" : {
"name" : "name",
"id" : 1
},
"draftCount" : 1,
"plannedCount" : 5,
"planIntervalTo" : "2000-01-23T04:56:07.000+00:00",
"externalId" : "externalId",
"warehouse" : {
"address" : "address",
"name" : "name",
"id" : 6
},
"shipmentType" : "IMPORT",
"planIntervalFrom" : "2000-01-23T04:56:07.000+00:00",
"statusDescription" : "statusDescription",
"warehouseTo" : {
"address" : "address",
"name" : "name",
"id" : 6
},
"factCount" : 5,
"palletsCount" : {
"fact" : 5,
"planned" : 5
},
"id" : 0,
"orderIds" : [ 6, 6 ],
"statusUpdateTime" : "2000-01-23T04:56:07.000+00:00",
"status" : "OUTBOUND_CREATED"
}, {
"deliveryService" : {
"name" : "name",
"id" : 1
},
"draftCount" : 1,
"plannedCount" : 5,
"planIntervalTo" : "2000-01-23T04:56:07.000+00:00",
"externalId" : "externalId",
"warehouse" : {
"address" : "address",
"name" : "name",
"id" : 6
},
"shipmentType" : "IMPORT",
"planIntervalFrom" : "2000-01-23T04:56:07.000+00:00",
"statusDescription" : "statusDescription",
"warehouseTo" : {
"address" : "address",
"name" : "name",
"id" : 6
},
"factCount" : 5,
"palletsCount" : {
"fact" : 5,
"planned" : 5
},
"id" : 0,
"orderIds" : [ 6, 6 ],
"statusUpdateTime" : "2000-01-23T04:56:07.000+00:00",
"status" : "OUTBOUND_CREATED"
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Найденные отгрузки.
SearchShipmentsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/pallets
Передача количества упаковок в отгрузке (setShipmentPalletsCount)
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Имеет значение только тип ответа. Если ответ
ОК, количество упаковок записано.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/transfer
Перенос заказов в следующую отгрузку (transferOrdersFromShipment)
Переносит указанные заказы из указанной отгрузки в следующую отгрузку. Что такое отгрузка?
Используйте этот запрос, если не успеваете собрать и упаковать заказы вовремя.
{% note warning "Такие переносы снижают индекс качества магазина" %}
Этот запрос предназначен для исключительных случаев. Если вы будете переносить заказы слишком часто, магазин столкнется с ограничениями. Что за ограничения?
{% endnote %}
Переносить заказы можно, если до формирования отгрузки осталось больше получаса.
Перенос происходит не мгновенно, а занимает несколько минут.
|⚙️ Лимит: 200 запросов в час|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
shipmentId (required)
Path Parameter — Идентификатор отгрузки. default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Запрос на перенос заказов проверен и принят, и они будут перенесены спустя несколько минут.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /campaigns/{campaignId}/offers/stocks
Информация об остатках и оборачиваемости (getStocks)
Возвращает данные об остатках товаров (для всех моделей) и об оборачиваемости товаров (для модели FBY).
{% note info "По умолчанию данные по оборачивамости не возращаются" %}
Чтобы они были в ответе, передавайте true в поле withTurnover.
{% endnote %}
|⚙️ Лимит: 100 000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
page_token (optional)
Query Parameter —
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.
Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
default: null
limit (optional)
Query Parameter — Количество значений на одной странице. default: null format: int32
Return type
Example data
Content-Type: application/json
{
"result" : {
"warehouses" : [ {
"offers" : [ {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"warehouseId" : 0
}, {
"offers" : [ {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
"offerId" : "offerId",
"turnoverSummary" : {
"turnoverDays" : 6.027456183070403,
"turnover" : "LOW"
},
"stocks" : [ {
"count" : 1,
"type" : "FIT"
}, {
"count" : 1,
"type" : "FIT"
} ],
"updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ],
"warehouseId" : 0
} ],
"paging" : {
"prevPageToken" : "prevPageToken",
"nextPageToken" : "nextPageToken"
}
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Остатки товаров на складах.
GetWarehouseStocksResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
put /campaigns/{campaignId}/offers/stocks
Передача информации об остатках (updateStocks)
Передает данные об остатках товаров на витрине.
Обязательно указывайте SKU в точности так, как он указан в каталоге. Например, 557722 и 0557722 — это два разных SKU.
{% note info "Данные в каталоге обновляются не мгновенно" %}
Это занимает до нескольких минут.
{% endnote %}
|⚙️ Лимит: 100 000 товаров в минуту|
|-|
Path parameters
campaignId (required)
Path Parameter —
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.
Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.
ℹ️ Что такое кабинет и магазин на Маркете
default: null format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Пустой ответ.
EmptyApiResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
post /tariffs/calculate
Калькулятор стоимости услуг (calculateTariffs)
Рассчитывает стоимость услуг Маркета для товаров с заданными параметрами. Порядок товаров в запросе и ответе сохраняется, чтобы определить,
для какого товара рассчитана стоимость услуги.
Обратите внимание: калькулятор осуществляет примерные расчеты. Финальная стоимость для каждого заказа зависит от предоставленных услуг.
В запросе можно указать либо параметр campaignId, либо sellingProgram. Совместное использование параметров приведет к ошибке.
|⚙️ Лимит: 100 запросов в минуту|
|-|
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result" : {
"offers" : [ {
"offer" : {
"quantity" : 1,
"price" : 0.6027456183070403,
"length" : 0.14658129805029452,
"width" : 0.5962133916683182,
"weight" : 0.23021358869347652,
"categoryId" : 0,
"height" : 0.5637376656633328
},
"tariffs" : [ {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
}, {
"offer" : {
"quantity" : 1,
"price" : 0.6027456183070403,
"length" : 0.14658129805029452,
"width" : 0.5962133916683182,
"weight" : 0.23021358869347652,
"categoryId" : 0,
"height" : 0.5637376656633328
},
"tariffs" : [ {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
}, {
"amount" : 9.301444243932576,
"type" : "AGENCY_COMMISSION",
"parameters" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ]
} ]
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Стоимость услуг.
CalculateTariffsResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Идентификаторы складов Маркета (FBY) (getFulfillmentWarehouses)
Возвращает список складов Маркета с их идентификаторами.
|⚙️ Лимит: 100 запросов в минуту|
|-|
Return type
Example data
Content-Type: application/json
{
"result" : {
"warehouses" : [ {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"name" : "name",
"id" : 0
}, {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"name" : "name",
"id" : 0
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список складов.
GetFulfillmentWarehousesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
Up
get /businesses/{businessId}/warehouses
Список складов и групп складов (getWarehouses)
Возвращает список складов и, если склады объединены, список групп складов. Что такое группы складов и зачем они нужны
Среди прочего запрос позволяет определить идентификатор, который нужно использовать при передаче остатков для группы складов.
|⚙️ Лимит: 100 запросов в минуту|
|-|
Path parameters
Return type
Example data
Content-Type: application/json
{
"result" : {
"warehouses" : [ {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}, {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
} ],
"warehouseGroups" : [ {
"name" : "name",
"warehouses" : [ {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}, {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
} ],
"mainWarehouse" : {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}
}, {
"name" : "name",
"warehouses" : [ {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}, {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
} ],
"mainWarehouse" : {
"address" : {
"number" : "number",
"city" : "city",
"street" : "street",
"block" : "block",
"gps" : {
"latitude" : 9.965781217890562,
"longitude" : 9.369310271410669
},
"building" : "building"
},
"campaignId" : 6,
"name" : "name",
"express" : true,
"id" : 0
}
} ]
},
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Example data
Content-Type: application/json
{
"errors" : [ {
"code" : "code",
"message" : "message"
}, {
"code" : "code",
"message" : "message"
} ],
"status" : "OK"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Список складов и групп складов.
GetWarehousesResponse
400
Запрос содержит неправильные данные.
ApiClientDataErrorResponse
401
В запросе не указаны данные для авторизации.
ApiUnauthorizedErrorResponse
403
Данные для авторизации неверны или доступ к ресурсу запрещен.
ApiForbiddenErrorResponse
404
Запрашиваемый ресурс не найден.
ApiNotFoundErrorResponse
420
Превышено ограничение на доступ к ресурсу.
ApiLimitErrorResponse
500
Внутренняя ошибка сервера.
ApiServerErrorResponse
[ Jump to Methods ]
Table of Contents
AcceptOrderCancellationRequest - AddHiddenOffersRequest - AddOffersToArchiveDTO - AddOffersToArchiveErrorDTO - AddOffersToArchiveErrorType - AddOffersToArchiveRequest - AddOffersToArchiveResponse - AffectedOrderQualityRatingComponentType - AgeDTO - AgeUnitType - ApiClientDataErrorResponse - ApiErrorDTO - ApiErrorResponse - ApiForbiddenErrorResponse - ApiLimitErrorResponse - ApiLockedErrorResponse - ApiNotFoundErrorResponse - ApiResponse - ApiResponseStatusType - ApiServerErrorResponse - ApiUnauthorizedErrorResponse - BaseCampaignOfferDTO - BaseOfferDTO - BasePriceDTO - BaseShipmentDTO - BidRecommendationItemDTO - BriefOrderItemDTO - BriefOrderItemInstanceDTO - BusinessDTO - BusinessSettingsDTO - CalculateTariffsOfferDTO - CalculateTariffsOfferInfoDTO - CalculateTariffsParametersDTO - CalculateTariffsRequest - CalculateTariffsResponse - CalculateTariffsResponseDTO - CalculatedTariffDTO - CalculatedTariffType - CampaignDTO - CampaignQualityRatingDTO - CampaignSettingsDTO - CampaignSettingsDeliveryDTO - CampaignSettingsLocalRegionDTO - CampaignSettingsScheduleDTO - CampaignSettingsScheduleSourceType - CampaignSettingsTimePeriodDTO - CampaignsQualityRatingDTO - CategoryContentParametersDTO - CategoryDTO - CategoryErrorDTO - CategoryErrorType - CategoryParameterDTO - CategoryParameterUnitDTO - ChangeOutletRequest - ChannelType - ChatMessageDTO - ChatMessagePayloadDTO - ChatMessageSenderType - ChatMessagesResultDTO - ChatStatusType - ChatType - ConfirmPricesRequest - ConfirmShipmentRequest - CreateChatRequest - CreateChatResponse - CreateChatResultDTO - CreateOutletResponse - CurrencyType - DayOfWeekType - DeleteCampaignOffersDTO - DeleteCampaignOffersRequest - DeleteCampaignOffersResponse - DeleteGoodsFeedbackCommentRequest - DeleteHiddenOffersRequest - DeleteOffersDTO - DeleteOffersFromArchiveDTO - DeleteOffersFromArchiveRequest - DeleteOffersFromArchiveResponse - DeleteOffersRequest - DeleteOffersResponse - DeletePromoOffersRequest - DeletePromoOffersResponse - DeletePromoOffersResultDTO - DeliveryServiceDTO - DeliveryServiceInfoDTO - DeliveryServicesDTO - DocumentDTO - EacVerificationResultDTO - EacVerificationStatusType - EmptyApiResponse - EnrichedMappingsOfferDTO - EnrichedModelDTO - EnrichedModelsDTO - EnrichedOrderBoxLayoutDTO - ExtensionShipmentDTO - FeedContentDTO - FeedContentErrorDTO - FeedContentErrorType - FeedDTO - FeedDownloadDTO - FeedDownloadErrorDTO - FeedDownloadErrorType - FeedIndexLogsErrorDTO - FeedIndexLogsErrorType - FeedIndexLogsFeedDTO - FeedIndexLogsIndexType - FeedIndexLogsOffersDTO - FeedIndexLogsRecordDTO - FeedIndexLogsResultDTO - FeedIndexLogsStatusType - FeedParameterDTO - FeedPlacementDTO - FeedPublicationDTO - FeedPublicationFullDTO - FeedPublicationPriceAndStockUpdateDTO - FeedStatusType - FeedbackAuthorDTO - FeedbackCommentAuthorDTO - FeedbackCommentAuthorType - FeedbackCommentDTO - FeedbackDTO - FeedbackDeliveryType - FeedbackFactorDTO - FeedbackGradesDTO - FeedbackListDTO - FeedbackOrderDTO - FeedbackReactionStatusType - FeedbackShopDTO - FeedbackStateType - FieldStateType - FlippingPagerDTO - ForwardScrollingPagerDTO - FulfillmentWarehouseDTO - FulfillmentWarehousesDTO - FullOutletDTO - FullOutletLicenseDTO - GenerateBoostConsolidatedRequest - GenerateCompetitorsPositionReportRequest - GenerateGoodsFeedbackRequest - GenerateGoodsMovementReportRequest - GenerateGoodsRealizationReportRequest - GenerateGoodsTurnoverRequest - GenerateMassOrderLabelsRequest - GeneratePricesReportRequest - GenerateReportDTO - GenerateReportResponse - GenerateShelfsStatisticsRequest - GenerateShipmentListDocumentReportRequest - GenerateShowsSalesReportRequest - GenerateStocksOnWarehousesReportRequest - GenerateUnitedMarketplaceServicesReportRequest - GenerateUnitedNettingReportRequest - GenerateUnitedOrdersRequest - GetAllOffersResponse - GetBidsInfoRequest - GetBidsInfoResponse - GetBidsInfoResponseDTO - GetBidsRecommendationsRequest - GetBidsRecommendationsResponse - GetBidsRecommendationsResponseDTO - GetBusinessBuyerInfoResponse - GetBusinessDocumentsInfoResponse - GetBusinessSettingsInfoDTO - GetBusinessSettingsResponse - GetCampaignLoginsResponse - GetCampaignOfferDTO - GetCampaignOffersRequest - GetCampaignOffersResponse - GetCampaignOffersResultDTO - GetCampaignRegionResponse - GetCampaignResponse - GetCampaignSettingsResponse - GetCampaignsResponse - GetCategoriesMaxSaleQuantumDTO - GetCategoriesMaxSaleQuantumRequest - GetCategoriesMaxSaleQuantumResponse - GetCategoriesRequest - GetCategoriesResponse - GetCategoryContentParametersResponse - GetChatHistoryRequest - GetChatHistoryResponse - GetChatInfoDTO - GetChatsInfoDTO - GetChatsRequest - GetChatsResponse - GetDeliveryServicesResponse - GetFeedIndexLogsResponse - GetFeedResponse - GetFeedbackListResponse - GetFeedsResponse - GetFulfillmentWarehousesResponse - GetGoodsFeedbackCommentsRequest - GetGoodsFeedbackCommentsResponse - GetGoodsFeedbackRequest - GetGoodsFeedbackResponse - GetGoodsStatsRequest - GetGoodsStatsResponse - GetHiddenOffersResponse - GetHiddenOffersResultDTO - GetMappingDTO - GetModelsOffersResponse - GetModelsRequest - GetModelsResponse - GetOfferCardsContentStatusRequest - GetOfferCardsContentStatusResponse - GetOfferDTO - GetOfferMappingDTO - GetOfferMappingEntriesResponse - GetOfferMappingsRequest - GetOfferMappingsResponse - GetOfferMappingsResultDTO - GetOfferRecommendationsRequest - GetOfferRecommendationsResponse - GetOffersResponse - GetOrderBuyerInfoResponse - GetOrderLabelsDataResponse - GetOrderResponse - GetOrdersResponse - GetOrdersStatsRequest - GetOrdersStatsResponse - GetOutletLicensesResponse - GetOutletResponse - GetOutletsResponse - GetPriceDTO - GetPriceWithDiscountDTO - GetPriceWithVatDTO - GetPricesByOfferIdsRequest - GetPricesByOfferIdsResponse - GetPricesResponse - GetPromoAssortmentInfoDTO - GetPromoBestsellerInfoDTO - GetPromoConstraintsDTO - GetPromoDTO - GetPromoMechanicsInfoDTO - GetPromoOfferDTO - GetPromoOffersRequest - GetPromoOffersResponse - GetPromoOffersResultDTO - GetPromoPromocodeInfoDTO - GetPromosRequest - GetPromosResponse - GetPromosResultDTO - GetQualityRatingDetailsResponse - GetQualityRatingRequest - GetQualityRatingResponse - GetQuarantineOffersRequest - GetQuarantineOffersResponse - GetQuarantineOffersResultDTO - GetRegionWithChildrenResponse - GetRegionsResponse - GetReportInfoResponse - GetReturnResponse - GetReturnsResponse - GetShipmentOrdersInfoResponse - GetShipmentResponse - GetSuggestedOfferMappingEntriesRequest - GetSuggestedOfferMappingEntriesResponse - GetSuggestedOfferMappingsRequest - GetSuggestedOfferMappingsResponse - GetSuggestedOfferMappingsResultDTO - GetWarehouseStocksDTO - GetWarehouseStocksRequest - GetWarehouseStocksResponse - GetWarehousesResponse - GoodsFeedbackCommentAuthorDTO - GoodsFeedbackCommentAuthorType - GoodsFeedbackCommentDTO - GoodsFeedbackCommentListDTO - GoodsFeedbackCommentStatusType - GoodsFeedbackDTO - GoodsFeedbackDescriptionDTO - GoodsFeedbackIdentifiersDTO - GoodsFeedbackListDTO - GoodsFeedbackMediaDTO - GoodsFeedbackStatisticsDTO - GoodsStatsDTO - GoodsStatsGoodsDTO - GoodsStatsWarehouseDTO - GoodsStatsWeightDimensionsDTO - GpsDTO - HiddenOfferDTO - LanguageType - LicenseCheckStatusType - LicenseType - LogisticPickupPointDTO - LogisticPointType - MappingsOfferDTO - MappingsOfferInfoDTO - MaxSaleQuantumDTO - MechanicsType - ModelDTO - ModelOfferDTO - ModelPriceDTO - ModelsDTO - OfferAvailabilityStatusType - OfferCampaignStatusDTO - OfferCampaignStatusType - OfferCardDTO - OfferCardRecommendationDTO - OfferCardRecommendationType - OfferCardStatusType - OfferCardsContentStatusDTO - OfferConditionDTO - OfferConditionQualityType - OfferConditionType - OfferContentDTO - OfferContentErrorDTO - OfferContentErrorType - OfferDTO - OfferErrorDTO - OfferForRecommendationDTO - OfferManualDTO - OfferMappingDTO - OfferMappingEntriesDTO - OfferMappingEntryDTO - OfferMappingErrorDTO - OfferMappingErrorType - OfferMappingInfoDTO - OfferMappingKindType - OfferMappingSuggestionsListDTO - OfferParamDTO - OfferPriceByOfferIdsListResponseDTO - OfferPriceByOfferIdsResponseDTO - OfferPriceDTO - OfferPriceListResponseDTO - OfferPriceResponseDTO - OfferProcessingNoteDTO - OfferProcessingNoteType - OfferProcessingStateDTO - OfferProcessingStatusType - OfferRecommendationDTO - OfferRecommendationInfoDTO - OfferRecommendationsResultDTO - OfferSellingProgramDTO - OfferSellingProgramStatusType - OfferType - OfferWeightDimensionsDTO - OffersDTO - OptionValuesLimitedDTO - OrderBoxLayoutDTO - OrderBoxLayoutItemDTO - OrderBoxLayoutPartialCountDTO - OrderBoxesLayoutDTO - OrderBusinessBuyerDTO - OrderBusinessDocumentsDTO - OrderBuyerBasicInfoDTO - OrderBuyerDTO - OrderBuyerInfoDTO - OrderBuyerType - OrderCancellationReasonType - OrderCourierDTO - OrderDTO - OrderDeliveryAddressDTO - OrderDeliveryDTO - OrderDeliveryDateDTO - OrderDeliveryDateReasonType - OrderDeliveryDatesDTO - OrderDeliveryDispatchType - OrderDeliveryEacType - OrderDeliveryPartnerType - OrderDeliveryType - OrderDigitalItemDTO - OrderDocumentStatusType - OrderItemDTO - OrderItemDetailDTO - OrderItemInstanceDTO - OrderItemInstanceModificationDTO - OrderItemInstanceType - OrderItemModificationDTO - OrderItemPromoDTO - OrderItemStatusType - OrderItemSubsidyDTO - OrderItemSubsidyType - OrderItemsModificationRequestReasonType - OrderItemsModificationResultDTO - OrderLabelDTO - OrderLiftType - OrderParcelBoxDTO - OrderPaymentMethodType - OrderPaymentType - OrderPromoType - OrderShipmentDTO - OrderStateDTO - OrderStatsStatusType - OrderStatusChangeDTO - OrderStatusChangeDeliveryDTO - OrderStatusChangeDeliveryDatesDTO - OrderStatusType - OrderSubsidyDTO - OrderSubsidyType - OrderSubstatusType - OrderTaxSystemType - OrderTrackDTO - OrderUpdateStatusType - OrderVatType - OrdersShipmentInfoDTO - OrdersStatsCommissionDTO - OrdersStatsCommissionType - OrdersStatsDTO - OrdersStatsDeliveryRegionDTO - OrdersStatsDetailsDTO - OrdersStatsItemDTO - OrdersStatsItemStatusType - OrdersStatsOrderDTO - OrdersStatsOrderPaymentType - OrdersStatsPaymentDTO - OrdersStatsPaymentOrderDTO - OrdersStatsPaymentSourceType - OrdersStatsPaymentType - OrdersStatsPriceDTO - OrdersStatsPriceType - OrdersStatsStockType - OrdersStatsWarehouseDTO - OutletAddressDTO - OutletDTO - OutletDeliveryRuleDTO - OutletLicenseDTO - OutletLicensesResponseDTO - OutletResponseDTO - OutletStatusType - OutletType - OutletVisibilityType - OutletWorkingScheduleDTO - OutletWorkingScheduleItemDTO - PageFormatType - PagedReturnsDTO - PalletsCountDTO - ParameterType - ParameterValueConstraintsDTO - ParameterValueDTO - ParameterValueOptionDTO - ParcelBoxDTO - ParcelBoxLabelDTO - ParcelDTO - PartnerShipmentWarehouseDTO - PaymentFrequencyType - PickupAddressDTO - PlacementType - PriceCompetitivenessThresholdsDTO - PriceCompetitivenessType - PriceDTO - PriceQuarantineVerdictDTO - PriceQuarantineVerdictParamNameType - PriceQuarantineVerdictParameterDTO - PriceQuarantineVerdictType - PriceRecommendationItemDTO - PriceSuggestDTO - PriceSuggestOfferDTO - PriceSuggestType - PromoOfferAutoParticipatingDetailsDTO - PromoOfferDiscountParamsDTO - PromoOfferParamsDTO - PromoOfferParticipationStatusFilterType - PromoOfferParticipationStatusType - PromoOfferPromocodeParamsDTO - PromoOfferUpdateWarningCodeType - PromoOfferUpdateWarningDTO - PromoParticipationType - PromoPeriodDTO - ProvideOrderDigitalCodesRequest - ProvideOrderItemIdentifiersRequest - ProvideOrderItemIdentifiersResponse - PutSkuBidsRequest - QualityRatingAffectedOrderDTO - QualityRatingComponentDTO - QualityRatingComponentType - QualityRatingDTO - QualityRatingDetailsDTO - QuantumDTO - QuarantineOfferDTO - RecipientType - RefundStatusType - RegionDTO - RegionType - RegionalModelInfoDTO - RejectedPromoOfferDeleteDTO - RejectedPromoOfferDeleteReasonType - RejectedPromoOfferUpdateDTO - RejectedPromoOfferUpdateReasonType - ReportFormatType - ReportInfoDTO - ReportStatusType - ReportSubStatusType - ReturnDTO - ReturnDecisionDTO - ReturnDecisionReasonType - ReturnDecisionSubreasonType - ReturnDecisionType - ReturnInstanceDTO - ReturnInstanceStatusType - ReturnInstanceStockType - ReturnItemDTO - ReturnRequestDecisionType - ReturnShipmentStatusType - ReturnType - ScrollingPagerDTO - SearchModelsResponse - SearchShipmentsRequest - SearchShipmentsResponse - SearchShipmentsResponseDTO - SellingProgramType - SendMessageToChatRequest - SetFeedParamsRequest - SetOrderBoxLayoutRequest - SetOrderBoxLayoutResponse - SetOrderDeliveryDateRequest - SetOrderDeliveryTrackCodeRequest - SetOrderShipmentBoxesRequest - SetOrderShipmentBoxesResponse - SetReturnDecisionRequest - SetShipmentPalletsCountRequest - ShelfsStatisticsAttributionType - ShipmentActionType - ShipmentBoxesDTO - ShipmentDTO - ShipmentInfoDTO - ShipmentPalletLabelPageFormatType - ShipmentStatusChangeDTO - ShipmentStatusType - ShipmentType - ShowsSalesGroupingType - SkipGoodsFeedbackReactionRequest - SkuBidItemDTO - SkuBidRecommendationItemDTO - SortOrderType - SuggestOfferPriceDTO - SuggestPricesRequest - SuggestPricesResponse - SuggestPricesResultDTO - SuggestedOfferDTO - SuggestedOfferMappingDTO - TariffDTO - TariffParameterDTO - TariffType - TimePeriodDTO - TimeUnitType - TrackDTO - TransferOrdersFromShipmentRequest - TurnoverDTO - TurnoverType - UnitDTO - UpdateBusinessOfferPriceDTO - UpdateBusinessPricesRequest - UpdateCampaignOfferDTO - UpdateCampaignOffersRequest - UpdateGoodsFeedbackCommentDTO - UpdateGoodsFeedbackCommentRequest - UpdateGoodsFeedbackCommentResponse - UpdateMappingDTO - UpdateMappingsOfferDTO - UpdateOfferContentRequest - UpdateOfferContentResponse - UpdateOfferContentResultDTO - UpdateOfferDTO - UpdateOfferMappingDTO - UpdateOfferMappingEntryDTO - UpdateOfferMappingEntryRequest - UpdateOfferMappingResultDTO - UpdateOfferMappingsRequest - UpdateOfferMappingsResponse - UpdateOrderItemRequest - UpdateOrderStatusDTO - UpdateOrderStatusRequest - UpdateOrderStatusResponse - UpdateOrderStatusesDTO - UpdateOrderStatusesRequest - UpdateOrderStatusesResponse - UpdateOrderStorageLimitRequest - UpdateOutletLicenseRequest - UpdatePriceWithDiscountDTO - UpdatePricesRequest - UpdatePromoOfferDTO - UpdatePromoOfferDiscountParamsDTO - UpdatePromoOfferParamsDTO - UpdatePromoOffersRequest - UpdatePromoOffersResponse - UpdatePromoOffersResultDTO - UpdateStockDTO - UpdateStockItemDTO - UpdateStocksRequest - UpdateTimeDTO - ValueRestrictionDTO - VerifyOrderEacRequest - VerifyOrderEacResponse - WarehouseAddressDTO - WarehouseDTO - WarehouseGroupDTO - WarehouseOfferDTO - WarehouseOffersDTO - WarehouseStockDTO - WarehouseStockType - WarehousesDTO - WarningPromoOfferUpdateDTO -
accepted
Boolean Решение об отмене заказа:
true — заказ отменяется, служба доставки узнала об отмене до передачи заказа покупателю.false — заказ не отменяется, так как он уже доставлен покупателю курьером или передан в пункт выдачи заказов.
reason (optional)
Запрос на скрытие оферов.
Товары, которые не удалось поместить в архив.
notArchivedOffers (optional)
Товар, который не удалось поместить в архив.
offerId
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
error
Причина, по которой товар не удалось поместить в архив:
OFFER_HAS_STOCKS — товар хранится на складе Маркета.
Товары, которые нужно поместить в архив.
Результат архивации товаров.
status (optional)
result (optional)
Составляющие индекса качества.
Для модели DBS:
DBS_CANCELLATION_RATE — доля отмененных товаров.DBS_LATE_DELIVERY_RATE — доля заказов, доставленных после плановой даты.
Для моделей FBS и Экспресс:
FBS_CANCELLATION_RATE — доля отмененных товаров.FBS_LATE_SHIP_RATE — доля не вовремя отгруженных заказов.
Возраст в заданных единицах измерения.
Единицы измерения возраста:
YEAR — год.MONTH — месяц.
Ошибка в данных переданных от клиента.
status (optional)
errors (optional)
Стандартная обертка для ошибок сервера.
status (optional)
errors (optional)
Неверны авторизационные данные, указанные в запросе, или запрещен доступ к запрашиваемому ресурсу.
status (optional)
errors (optional)
Превышено ограничение на доступ к ресурсу.
status (optional)
errors (optional)
Ресурс из запроса заблокирован от применения к нему указанного метода.
status (optional)
errors (optional)
Запрашиваемый ресурс не найден.
status (optional)
errors (optional)
Стандартная обертка для ответов сервера.
Внутренняя ошибка сервера.
status (optional)
errors (optional)
В запросе не указаны авторизационные данные.
status (optional)
errors (optional)
Информация о новой цене на товар.
offerId
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
quantum (optional)
available (optional)
Основные параметры товара.
offerId
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
name (optional)
String Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке.
Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей.
Оптимальная длина — 50–60 символов, максимальная — 256.
Рекомендации и правила
marketCategoryId (optional)
Long Идентификатор категории на Маркете, к которой вы относите свой товар.
Если не указать marketCategoryId, то маркетная категория будет определена автоматически.
При изменении информации о товаре передавайте тот же идентификатор категории. Если вы укажете другой, категория товара не поменяется. Изменить ее можно только в кабинете продавца на Маркете.
Список категорий Маркета можно получить с помощью запроса POST categories/tree.
format: int64
category (optional)
String Категория товара в вашем магазине. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.
Указывайте конкретные категории — например, набор ножей лучше отнести к категории Столовые приборы, а не просто Посуда.
Выбирайте категории, которые описывают товар, а не абстрактный признак — например, Духи, а не Подарки.
Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.
pictures (optional)
array[String] Ссылки на изображения товара. Изображение по первой ссылке считается основным, остальные дополнительными.
Требования к ссылкам
- Ссылок может быть до 30.
- Указывайте ссылку целиком, включая протокол http или https.
- Максимальная длина — 512 символов.
- Русские буквы в URL можно.
- Можно использовать прямые ссылки на изображения и на Яндекс Диск. Ссылки на Яндекс Диске нужно копировать с помощью функции Поделиться. Относительные ссылки и ссылки на другие облачные хранилища — не работают.
✅ https://example-shop.ru/images/sku12345.jpg
✅ https://yadi.sk/i/NaBoRsimVOLov
❌ /images/sku12345.jpg
❌ https://www.dropbox.com/s/818f/tovar.jpg
Ссылки на изображение должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке.
Если нужно заменить изображение, выложите новое изображение по новой ссылке, а ссылку на старое удалите. Если просто заменить изображение по старой ссылке, оно не обновится.
Требования к изображениям
videos (optional)
array[String] Ссылка (URL) на видео товара.
Максимальное количество ссылок — 6.
Требования к ссылке
- Указывайте ссылку целиком, включая протокол http или https.
- Максимальная длина — 512 символов.
- Русские буквы в URL можно.
- Можно использовать прямые ссылки на видео и на Яндекс Диск. Ссылки на Яндекс Диске нужно копировать с помощью функции Поделиться. Относительные ссылки и ссылки на другие облачные хранилища — не работают.
✅ https://example-shop.ru/video/sku12345.avi
✅ https://yadi.sk/i/NaBoRsimVOLov
❌ /video/sku12345.avi
❌ https://www.dropbox.com/s/818f/super-tovar.avi
Ссылки на видео должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке.
Если нужно заменить видео, выложите новое видео по новой ссылке, а ссылку на старое удалите. Если просто заменить видео по старой ссылке, оно не обновится.
Требования к видео
manuals (optional)
array[OfferManualDTO] Список инструкций по использованию товара.
Максимальное количество инструкций — 6.
Если вы передадите пустое поле manuals, загруженные ранее инструкции удалятся.
vendor (optional)
String Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.
barcodes (optional)
array[String] Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128.
Для книг указывайте ISBN.
Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN.
Что такое GTIN
description (optional)
String Подробное описание товара: например, его преимущества и особенности.
Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок.
Можно использовать теги:
- <h>, <h1>, <h2> и так далее — для заголовков;
- <br> и <p> — для переноса строки;
- <ol> — для нумерованного списка;
- <ul> — для маркированного списка;
- <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>);
- <div> — поддерживается, но не влияет на отображение текста.
Оптимальная длина — 400–600 символов, максимальная — 6000.
Рекомендации и правила
manufacturerCountries (optional)
array[String] Страна, где был произведен товар.
Записывайте названия стран так, как они записаны в списке.
weightDimensions (optional)
vendorCode (optional)
String Артикул товара от производителя.
tags (optional)
array[String] Метки товара, используемые магазином. Покупателям теги не видны. По тегам можно группировать и фильтровать разные товары в каталоге — например, товары одной серии, коллекции или линейки.
Максимальная длина тега 20 символов. У одного товара может быть максимум 10 тегов. Всего можно создать не больше 50 разных тегов.
shelfLife (optional)
lifeTime (optional)
guaranteePeriod (optional)
customsCommodityCode (optional)
String Код товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД) — 10 или 14 цифр без пробелов.
Обязательно укажите, если он есть.
certificates (optional)
array[String] Номера документов на товар: сертификата, декларации соответствия и т. п.
Передавать можно только номера документов, сканы которого загружены в кабинете продавца по инструкции.
boxCount (optional)
Integer Количество грузовых мест.
Параметр используется, если товар представляет собой несколько коробок, упаковок и так далее. Например, кондиционер занимает два места — внешний и внутренний блоки в двух коробках.
Для товаров, занимающих одно место, не передавайте этот параметр.
format: int32
condition (optional)
type (optional)
downloadable (optional)
adult (optional)
Boolean Параметр включает для товара пометку 18+. Устанавливайте ее только для товаров, которые относятся к удовлетворению сексуальных потребностей.
age (optional)
params (optional)
array[OfferParamDTO] {% note warning "" %}
Этот параметр устарел. При передаче характеристик используйте parameterValues.
{% endnote %}
Характеристики, которые есть только у товаров конкретной категории — например, диаметр колес велосипеда или материал подошвы обуви.
Информация об отгрузке.
id (optional)
Long Идентификатор отгрузки. format: int64
planIntervalFrom (optional)
Date Начало планового интервала отгрузки. format: date-time
planIntervalTo (optional)
Date Конец планового интервала отгрузки. format: date-time
shipmentType (optional)
warehouse (optional)
warehouseTo (optional)
externalId (optional)
String Идентификатор отгрузки в вашей системе. Если вы еще не передавали идентификатор, вернется идентификатор из параметра
id.
deliveryService (optional)
palletsCount (optional)
orderIds
set[Long] Идентификаторы заказов в отгрузке. format: int64
draftCount (optional)
Integer Количество заказов, которое Маркет запланировал к отгрузке. format: int32
plannedCount (optional)
Integer Количество заказов, которое Маркет подтвердил к отгрузке. format: int32
factCount (optional)
Integer Количество заказов, принятых в сортировочном центре или пункте приема. format: int32
Рекомендованная ставка и возможная доля показов.
bid
Integer Значение ставки. format: int32
showPercent
Long Доля показов. format: int64
Информация о маркированном товаре.
id (optional)
Long Идентификатор товара в заказе.
Позволяет идентифицировать товар в рамках данного заказа.
format: int64
vat (optional)
count (optional)
Integer Количество единиц товара. format: int32
price (optional)
BigDecimal Цена на товар. Указана в той валюте, которая была задана в каталоге. Разделитель целой и дробной части — точка.
offerName (optional)
offerId (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
instances (optional)
Идентификатор единицы товара.
Заполните только одно поле в зависимости от того, в какой системе маркирован товар.
Подробно о работе с маркируемыми товарами рассказано в Справке Маркета для продавцов.
cis (optional)
String Код идентификации единицы товара в системе «Честный ЗНАК».
{% note warning %}
Не экранируйте косую черту в коде символа-разделителя \u001d!
✅ 01030410947874432155Qbag!\u001d93Zjqw
❌ 01030410947874432155Qbag!\\u001d93Zjqw
Косые черты и кавычки в других местах экранируйте по правилам JSON: \\ и \"
{% endnote %}
uin (optional)
String Уникальный идентификационный номер ювелирного изделия.
Представляет собой число из 16 цифр.
rnpt (optional)
String Регистрационный номер партии товара.
Представляет собой строку из четырех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ/ХХХ.
Первая часть — код таможни, которая зарегистрировала декларацию на партию товара. Далее — дата, номер декларации и номер маркированного товара в декларации.
gtd (optional)
String Грузовая таможенная декларация.
Представляет собой строку из трех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ.
Первая часть — код таможни, которая зарегистрировала декларацию на ввезенные товары. Далее — дата и номер декларации.
Информация о кабинете.
id (optional)
Long Идентификатор кабинета. format: int64
name (optional)
Настройки кабинета.
onlyDefaultPrice (optional)
Boolean Можно ли установить только базовую цену:
false — можно задать и базовую цену, и цены в конкретных магазинах.true — можно задать только базовую цену.
currency (optional)
Параметры товара, для которого нужно рассчитать стоимость услуг.
categoryId
Long Идентификатор категории товара на Маркете.
Для расчета стоимости услуг необходимо указать идентификатор листовой категории товара — той, которая не имеет дочерних категорий.
Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом POST categories/tree.
format: int64
price
length
width
height
weight
quantity (optional)
Integer Квант продажи — количество единиц товара в одном товарном предложении. format: int32
Стоимость услуг.
offer
tariffs
array[CalculatedTariffDTO] Список услуг и их стоимость.
По некоторым услугам могут возвращаться несколько разных стоимостей. Например, в модели FBS стоимость услуги SORTING (обработка заказа) зависит от способа отгрузки и количества заказов в отгрузке. Подробнее о тарифах на услуги читайте в Справке Маркета для продавцов.
Параметры для расчета стоимости услуг.
campaignId (optional)
Long Идентификатор кампании. У пользователя, который выполняет запрос, должен быть доступ к этой кампании.
Используйте параметр campaignId, если уже завершили подключение магазина на Маркете. Иначе вернется пустой список.
Обязательный параметр, если не указан параметр sellingProgram. Совместное использование параметров приведет к ошибке.
format: int64
sellingProgram (optional)
frequency (optional)
status (optional)
result (optional)
Информация об услугах Маркета.
type
amount (optional)
parameters
Услуга Маркета:
-
AGENCY_COMMISSION — прием платежа покупателя.
-
PAYMENT_TRANSFER — перевод платежа покупателя.
-
FEE — размещение товара на Маркете.
-
DELIVERY_TO_CUSTOMER — доставка покупателю.
-
CROSSREGIONAL_DELIVERY — доставка в федеральный округ, город или населенный пункт.
-
EXPRESS_DELIVERY — экспресс-доставка покупателю.
-
SORTING — обработка заказа.
-
MIDDLE_MILE — средняя миля.
Подробнее об услугах Маркета читайте в Справке Маркета для продавцов.
Информация о магазине.
domain (optional)
id (optional)
Long Идентификатор кампании. format: int64
clientId (optional)
Long Идентификатор плательщика в Яндекс Балансе. format: int64
business (optional)
placementType (optional)
Информация об индексе качества магазина.
campaignId
Long Идентификатор магазина. format: int64
ratings
Настройки магазина.
countryRegion (optional)
Long Идентификатор региона, в котором находится магазин. format: int64
shopName (optional)
String Наименование магазина на Яндекс Маркете.
Если наименование отсутствует, значение параметра выводится —
null.
showInContext (optional)
Boolean Признак размещения магазина на сайтах партнеров Яндекс Дистрибуции.
Возможные значения:
false — магазин не размещен на сайтах партнеров Яндекс Дистрибуции.true — магазин размещен на сайтах партнеров Яндекс Дистрибуции.
showInPremium (optional)
Boolean Признак показа предложений магазина в рекламном блоке над результатами поиска (cпецразмещение).
Возможные значения:
false — предложения не показываются в блоке cпецразмещения.true — предложения показываются в блоке cпецразмещения.
useOpenStat (optional)
Boolean Признак использования внешней интернет-статистики.
Возможные значения:
false — внешняя интернет-статистика не используется.true — внешняя интернет-статистика используется.
localRegion (optional)
Информация о доставке в своем регионе магазина.
Информация о своем регионе магазина.
id (optional)
Long Идентификатор региона. format: int64
name (optional)
type (optional)
deliveryOptionsSource (optional)
delivery (optional)
Расписание работы службы доставки в своем регионе.
availableOnHolidays (optional)
Boolean Признак работы службы доставки в государственные праздники.
Возможные значения.
false — служба доставки не работает в праздничные дни.true — служба доставки работает в праздничные дни.
customHolidays
array[String] Список дней, в которые служба доставки не работает. Дни магазин указал в кабинете продавца на Маркете. format: date-dd-MM-yyyy
customWorkingDays
array[String] Список выходных и праздничных дней, в которые служба доставки работает. Дни магазин указал в кабинете продавца на Маркете. format: date-dd-MM-yyyy
period (optional)
totalHolidays
array[String] Итоговый список нерабочих дней службы доставки. Список рассчитывается с учетом выходных, нерабочих дней и государственных праздников. Информацию по ним магазин указывает в кабинете продавца на Маркете. format: date-dd-MM-yyyy
weeklyHolidays
array[Integer] Список выходных дней недели и государственных праздников. format: int32
Источник информации о расписании работы службы доставки.
Возможные значения:
WEB — информация получена из настроек кабинета продавца на Маркете.YML — информация получена из прайс-листа магазина.
Период, за который рассчитывается итоговый список нерабочих дней службы доставки.
fromDate (optional)
String Формат даты:
ДД-ММ-ГГГГ. format: date-dd-MM-yyyy
toDate (optional)
String Формат даты:
ДД-ММ-ГГГГ. format: date-dd-MM-yyyy
Информация об индексе качества магазинов.
Информация о параметрах категории.
categoryId
Integer Идентификатор категории на Маркете. Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом
POST categories/tree. format: int32
parameters (optional)
Информация о категории.
Категория считается листовой, если у нее нет дочерних категорий.
id
Long Идентификатор категории. format: int64
name
children (optional)
Текст ошибки.
categoryId (optional)
Long Идентификатор категории. format: int64
type (optional)
Типы ошибок:
UNKNOWN_CATEGORY — указана неизвестная категория.CATEGORY_IS_NOT_LEAF — указана нелистовая категория. Укажите ту, которая не имеет дочерних категорий.
Характеристика товара.
id
Long Идентификатор характеристики. format: int64
name (optional)
String Название характеристики.
type
unit (optional)
description (optional)
String Описание характеристики.
recommendationTypes (optional)
required
Boolean Обязательность характеристики.
filtering
Boolean Используется ли характеристика в фильтре.
distinctive
Boolean Является ли характеристика особенностью варианта.
multivalue
Boolean Можно ли передать сразу несколько значений.
allowCustomValues
Boolean Можно ли передавать собственное значение, которого нет в списке вариантов Маркета. Только для характеристик типа
ENUM.
values (optional)
constraints (optional)
valueRestrictions (optional)
Единицы измерения характеристики товара.
defaultUnitId
Long Единица измерения по умолчанию. format: int64
units
name
type
coords (optional)
String Координаты точки продаж.
Формат: долгота, широта. Разделители: запятая и / или пробел. Например, 20.4522144, 54.7104264.
Если параметр не передан, координаты будут определены по значениям параметров, вложенных в address.
isMain (optional)
Boolean Признак основной точки продаж.
Возможные значения:
false — неосновная точка продаж.true — основная точка продаж.
shopOutletCode (optional)
String Идентификатор точки продаж, присвоенный магазином.
visibility (optional)
address
phones
array[String] Номера телефонов точки продаж. Передавайте в формате:
+7 (999) 999-99-99.
workingSchedule
deliveryRules (optional)
array[OutletDeliveryRuleDTO] Информация об условиях доставки для данной точки продаж.
Обязательный параметр, если параметр type=DEPOT или type=MIXED.
storagePeriod (optional)
Long Срок хранения заказа в собственном пункте выдачи заказов. Считается в днях. format: int64
Каналы продвижения товаров:
-
PUSH — пуш-уведомление из приложения Яндекс Маркет.
-
STRETCH_MAIN — верхний баннер-растяжка на главной странице Яндекс Маркета.
-
MAIN_PAGE_CAROUSEL — карусель акций на главной странице Яндекс Маркета.
-
PRODUCT_RETAIL_PAGE — товар на странице ритейл-повода.
-
MAIN_PAGE_CAROUSEL_WEB — карусель акций на главной странице веб версии Яндекс Маркета.
-
PRODUCT_SEPARATE_LANDING — товар на лендинге акции.
-
SUPER_SHELF_CATEGORY — полка в категориях.
-
CAROUSEL_RETAIL_PAGE — карусель на лендинге ритейл-повода.
-
POPUP_APPLICATION — всплывающее окно в приложении Яндекс Маркет.
-
POST_TELEGRAM — пост в Телеграм-канале Яндекс Маркета.
-
CPA — реклама в партнерской сети Яндекс Маркета.
-
WEB_PERFORMANCE_DIRECT — реклама в Яндекс Директе.
-
APP_PERFORMANCE — реклама в AppStore и Google Play.
-
BANNER_PICKUP_POINT — баннер в ПВЗ Маркета.
-
BLOGGER_PERFORMANCE — рекламная интеграция у блогеров.
-
DIGITAL_CHANNEL_BANNER — баннер в digital-каналах и социальных сетях VK, Одноклассники.
-
YANDEX_ECOSYSTEM_CHANNELS — реклама в других сервисах Яндекса: GO, Delivery, Еда.
-
PARTNERS_MAIN_BANNER — баннер на главной странице mail.ru, auto.ru, ya.ru.
-
OTHER — прочее.
Информация о сообщениях.
messageId
Long Идентификатор сообщения. format: int64
createdAt
Date Дата и время создания сообщения.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:00:00+03:00.
format: date-time
sender
message (optional)
String Текст сообщения.
Необязательный параметр, если возвращается параметр payload.
payload (optional)
Информация о приложенных к сообщению файлах.
name
url
String Ссылка для скачивания файла.
size
Integer Размер файла в байтах. format: int32
Кто отправил сообщение:
PARTNER — магазин.CUSTOMER — покупатель.MARKET — Маркет.SUPPORT — сотрудник службы поддержки Маркета.
Информация о сообщениях.
orderId
Long Идентификатор заказа. format: int64
messages
paging (optional)
Статус чата:
NEW — новый чат.WAITING_FOR_CUSTOMER — нужен ответ покупателя.WAITING_FOR_PARTNER — нужен ответ магазина.WAITING_FOR_ARBITER — нужен ответ арбитра.WAITING_FOR_MARKET — нужен ответ Маркета.FINISHED — чат завершен.
Тип чата:
CHAT — чат с покупателем.ARBITRAGE — спор.
Запрос на подтверждение цены.
offerIds
array[String] Идентификаторы товаров, у которых подтверждается цена.
Запрос для подтверждения отгрузки.
externalShipmentId (optional)
String Идентификатор отгрузки в системе поставщика.
Заказ, для которого нужно создать чат.
orderId
Long Идентификатор заказа на Маркете. format: int64
Результат создания чата.
status (optional)
result (optional)
Информация о созданном чате.
chatId
Long Идентификатор чата. format: int64
Ответ на запрос о создании точки продаж.
status (optional)
result (optional)
Коды валют.
Возможные значения:
BYR — белорусский рубль.KZT — казахстанский тенге.RUR — российский рубль.UAH — украинская гривна.
День недели:
MONDAY — понедельник.TUESDAY — вторник.WEDNESDAY — среда.THURSDAY — четверг.FRIDAY — пятница.SATURDAY — суббота.SUNDAY — воскресенье.
Список товаров, которые не удалось удалить, потому что они не найдены или хранятся на складе Маркета.
notDeletedOfferIds (optional)
Фильтрации удаляемых товаров по offerIds.
Результат удаления товаров.
status (optional)
result (optional)
Фильтр запроса отзывов по бизнесу.
id
Long Идентификатор комментария к отзыву. format: int64
Запрос на возобновление показа оферов.
Список товаров, которые не удалось удалить, потому что они хранятся на складе Маркета.
notDeletedOfferIds (optional)
Товары, которые не удалось восстановить из архива.
notUnarchivedOfferIds (optional)
array[String] Список товаров, которые не удалось восстановить из архива.
Товары, которые нужно восстановить из архива.
offerIds
array[String] Список товаров, которые нужно восстановить из архива.
Результат разархивации товаров.
status (optional)
result (optional)
Фильтрации удаляемых товаров по offerIds.
Результат удаления товаров.
status (optional)
result (optional)
Удаление товаров из акции.
Чтобы убрать:
-
все товары из акции и больше не участвовать в ней, передайте значение true в параметре deleteAllOffers;
-
часть товаров, передайте их идентификаторы в параметре offersIds.
promoId
deleteAllOffers (optional)
Boolean Чтобы убрать все товары из акции и больше не участвовать в ней, передайте значение
true и не передавайте параметр
offerIds.
offerIds (optional)
Результат удаления товаров из акции.
status (optional)
result (optional)
Результат удаления товаров из акции.
Возвращается, только если в запросе был передан параметр offerIds.
rejectedOffers (optional)
Служба доставки.
id (optional)
Long Идентификатор службы доставки. format: int64
name (optional)
String Наименование службы доставки.
Информация о службе доставки.
id
Long Идентификатор службы доставки. format: int64
name
String Наименование службы доставки.
Информация о службах доставки.
Информация о документе.
status (optional)
number (optional)
date (optional)
date Дата создания документа. format: date
Результат выполнения запроса.
verificationResult (optional)
attemptsLeft (optional)
Integer Количество оставшихся попыток проверки кода.
Возвращается, если магазин отправил некорректный код.
Когда все попытки будут исчерпаны, код обновится.
format: int32
Статус проверки кода подтверждения:
ACCEPTED — код верный.REJECTED — код неверный.NEED_UPDATE — Маркет отправит новый код. Значение возвращается, если превышено количество попыток отправки кода.
Информация о рекомендованных карточках товаров.
name (optional)
String Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке.
Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей.
Оптимальная длина — 50–60 символов, максимальная — 256.
Рекомендации и правила
shopSku (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
category (optional)
String Категория товара в вашем магазине. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.
Указывайте конкретные категории — например, набор ножей лучше отнести к категории Столовые приборы, а не просто Посуда.
Выбирайте категории, которые описывают товар, а не абстрактный признак — например, Духи, а не Подарки.
Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.
vendor (optional)
String Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.
vendorCode (optional)
String Артикул товара от производителя.
description (optional)
String Подробное описание товара: например, его преимущества и особенности.
Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок.
Можно использовать теги:
- <h>, <h1>, <h2> и так далее — для заголовков;
- <br> и <p> — для переноса строки;
- <ol> — для нумерованного списка;
- <ul> — для маркированного списка;
- <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>);
- <div> — поддерживается, но не влияет на отображение текста.
Оптимальная длина — 400–600 символов, максимальная — 6000.
Рекомендации и правила
id (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
feedId (optional)
Long Идентификатор фида. format: int64
barcodes (optional)
array[String] Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128.
Для книг указывайте ISBN.
Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN.
Что такое GTIN
urls (optional)
array[String] URL фотографии товара или страницы с описанием на вашем сайте.
Переданные данные не будут отображаться на витрине, но они помогут специалистам Маркета найти карточку для вашего товара.
Должен содержать один вложенный параметр url.
pictures (optional)
array[String] Ссылки (URL) изображений товара в хорошем качестве.
Можно указать до 30 ссылок. При этом изображение по первой ссылке будет основным. Оно используется в качестве изображения товара в поиске Маркета и на карточке товара. Другие изображения товара доступны в режиме просмотра увеличенных изображений.
Обязательный параметр.
Должен содержать хотя бы один вложенный параметр picture.
manufacturer (optional)
String Изготовитель товара: компания, которая произвела товар, ее адрес и регистрационный номер (если есть).
Необязательный параметр.
manufacturerCountries (optional)
array[String] Список стран, в которых произведен товар.
Обязательный параметр.
Должен содержать хотя бы одну, но не больше 5 стран.
minShipment (optional)
Integer Минимальное количество единиц товара, которое вы поставляете на склад.
Например, если вы поставляете детское питание партиями минимум по 10 коробок, а в каждой коробке по 6 баночек, укажите значение 60.
format: int32
transportUnitSize (optional)
Integer Количество единиц товара в одной упаковке, которую вы поставляете на склад.
Например, если вы поставляете детское питание коробками по 6 баночек, укажите значение 6.
format: int32
quantumOfSupply (optional)
Integer Добавочная партия: по сколько единиц товара можно добавлять к минимальному количеству minShipment.
Например, если вы поставляете детское питание партиями минимум по 10 коробок и хотите добавлять к минимальной партии по 2 коробки, а в каждой коробке по 6 баночек, укажите значение 12.
format: int32
deliveryDurationDays (optional)
Integer Срок, за который продавец поставляет товары на склад, в днях. format: int32
boxCount (optional)
Integer Сколько мест (если больше одного) занимает товар.
Параметр указывается, только если товар занимает больше одного места (например, кондиционер занимает два места: внешний и внутренний блоки в двух коробках). Если товар занимает одно место, не указывайте этот параметр.
format: int32
customsCommodityCodes (optional)
array[String] Список кодов товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД).
Обязательный параметр, если товар подлежит особому учету (например, в системе «Меркурий» как продукция животного происхождения или в системе «Честный ЗНАК»).
Может содержать только один вложенный код ТН ВЭД.
weightDimensions (optional)
supplyScheduleDays (optional)
shelfLifeDays (optional)
Integer {% note warning "" %}
Этот параметр устарел. Вместо него используйте shelfLife. Совместное использование обоих параметров приведет к ошибке.
{% endnote %}
Срок годности: через сколько дней товар станет непригоден для использования.
format: int32
lifeTimeDays (optional)
Integer {% note warning "" %}
Этот параметр устарел. Вместо него используйте lifeTime. Совместное использование обоих параметров приведет к ошибке.
{% endnote %}
Срок службы: сколько дней товар будет исправно выполнять свою функцию, а изготовитель — нести ответственность за его существенные недостатки.
format: int32
guaranteePeriodDays (optional)
Integer Гарантийный срок товара: сколько дней возможно обслуживание и ремонт товара или возврат денег, а изготовитель или продавец будет нести ответственность за недостатки товара. format: int32
processingState (optional)
availability (optional)
shelfLife (optional)
lifeTime (optional)
guaranteePeriod (optional)
certificate (optional)
String Номер документа на товар.
Перед указанием номера документ нужно загрузить в кабинете продавца на Маркете. Инструкция
price (optional)
marketCategoryId (optional)
Long Идентификатор категории для рекомендованной карточки товара на Маркете.
Возвращается только вместе с параметром ##marketSku##.
format: int64
marketCategoryName (optional)
String Название категории для рекомендованной карточки товара на Маркете.
Может отсутствовать в ответе.
marketModelId (optional)
Long Идентификатор модели для рекомендованной карточки товара на Маркете.
Может отсутствовать в ответе.
format: int64
marketModelName (optional)
String Название модели для рекомендованной карточки товара на Маркете.
Возвращается только вместе с параметром ##marketSku##.
marketSku (optional)
Long SKU на Маркете. format: int64
marketSkuName (optional)
String Название товара с рекомендованной карточки на Маркете.
Может отсутствовать в ответе.
Модель товара.
id (optional)
Long Идентификатор модели товара. format: int64
name (optional)
String Название модели товара.
prices (optional)
offers (optional)
array[ModelOfferDTO] Список первых десяти предложений, расположенных на карточке модели.
В ответе на запрос возвращаются предложения различных магазинов. Если есть несколько предложений от одного магазина, в ответе отображается только одно, наиболее релевантное из них.
offlineOffers (optional)
Integer Суммарное количество предложений в розничных магазинах в регионе. Учитываются все предложения от каждого магазина. format: int32
onlineOffers (optional)
Integer Суммарное количество предложений в интернет-магазинах в регионе. Учитываются все предложения от каждого магазина. format: int32
Информация о коробке.
items
boxId (optional)
Long Идентификатор коробки. format: int64
Информация об отгрузке.
currentStatus (optional)
availableActions
Информация о проверке содержимого прайс-листа, загруженного на Маркет.
rejectedOffersCount (optional)
Long Количество предложений, в которых найдены ошибки на этапе загрузки прайс-листа.
Выводится, если параметр
content status=OK. format: int64
status (optional)
totalOffersCount (optional)
Long Количество предложений в прайс-листе.
Выводится, если параметр
content status=OK. format: int64
error (optional)
Информация об ошибке в содержимом прайс-листа.
Выводится, если параметр content status=ERROR.
Тип ошибки в содержимом прайс-листа.
Возможные значения:
PARSE_ERROR — ошибка при проверке прайс-листа, не связанная с форматом YML. Например, прайс-лист пустой или его не удалось разархивировать.PARSE_XML_ERROR — несоответствие техническим требованиям формата YML. Например, элементы и их значения описаны некорректно.TOO_MANY_REJECTED_OFFERS — более чем в половине предложений из прайс-листа найдены ошибки. Все предложения из прайс-листа не будут опубликованы на Маркете.
Информация о прайс-листе.
id (optional)
Long Идентификатор прайс-листа. format: int64
login (optional)
String Логин для авторизации при скачивании прайс-листа.
Параметр выводится при размещении прайс-листа на сайте магазина и в случае ограничения доступа к нему.
name (optional)
String Имя файла, содержащего прайс-лист.
Параметр выводится при размещении прайс-листа на сервере Маркета.
password (optional)
String Пароль для авторизации при скачивании прайс-листа.
Параметр выводится при размещении прайс-листа на сайте магазина и в случае ограничения доступа к нему.
uploadDate (optional)
Date Дата загрузки прайс-листа на Маркет.
Формат даты: ДД-ММ-ГГГГ.
Параметр выводится при размещении прайс-листа на сервере Маркета.
format: date-time
url (optional)
String URL прайс-листа.
Параметр выводится при размещении прайс-листа на сайте магазина.
content (optional)
download (optional)
placement (optional)
publication (optional)
Информация о последней загрузке прайс-листа.
status (optional)
error (optional)
Информация об ошибке при загрузке прайс-листа.
Выводится, если параметр download status=ERROR.
httpStatusCode (optional)
Integer HTTP-код ошибки индексации прайс-листа.
Выводится, если
type=DOWNLOAD_HTTP_ERROR. format: int32
type (optional)
description (optional)
String Описание ошибки.
Выводится, если
type=DOWNLOAD_ERROR.
Тип ошибки загрузки прайс-листа.
Возможные значения:
-
DOWNLOAD_ERROR — ошибка загрузки прайс-листа. Например, проблема с DNS-сервером или обрыв интернет-соединения.
Проблема описана в параметре description.
-
DOWNLOAD_HTTP_ERROR — Яндекс Маркет передал запрос на получение прайс-листа и получил в ответ HTTP-код, отличный от 2xx.
HTTP-код выведен в параметре httpStatusCode.
Информация об ошибке, произошедшей во время индексации прайс-листа.
Выводится, если во время индексации произошли ошибки (index-log-record status=ERROR).
httpStatusCode (optional)
Integer HTTP-код ошибки индексации прайс-листа.
Выводится, если type=DOWNLOAD_HTTP_ERROR.
format: int32
type (optional)
description (optional)
String Описание ошибки.
Выводится, если type=DOWNLOAD_ERROR.
Тип ошибки индексации прайс-листа.
Возможные значения:
-
DOWNLOAD_ERROR — ошибка загрузки прайс-листа. Например, проблема с DNS-сервером или обрыв интернет-соединения.
Проблема описана в параметре description.
-
DOWNLOAD_HTTP_ERROR — Маркет передал запрос на получение прайс-листа и получил в ответ HTTP-код, отличный от 2xx.
HTTP-код выведен в параметре httpStatusCode.
-
PARSE_ERROR — ошибка при проверке прайс-листа, не связанная с форматом YML. Например, прайс-лист пустой или его не удалось разархивировать.
-
PARSE_XML_ERROR — несоответствие техническим требованиям формата YML. Например, элементы и их значения описаны некорректно.
-
TOO_MANY_REJECTED_OFFERS — более чем в половине предложений из прайс-листа найдены ошибки. Все предложения из прайс-листа не будут опубликованы на Маркете.
Информация о прайс-листе.
id (optional)
Long Идентификатор прайс-листа. format: int64
Тип обновления.
Возможные значения:
DIFF — частичное обновление данных на Яндекс Маркете (например, обновление цен ранее опубликованных предложений и публикация новых).FAST_PRICE — только обновление цен ранее опубликованных предложений.FULL — полное обновление данных на Яндекс Маркете.
Информация о предложениях прайс-листа.
rejectedCount (optional)
Long Количество предложений, который не опубликованы на Маркете из-за найденных ошибок. format: int64
totalCount (optional)
Long Количество предложений в прайс-листе. format: int64
Список отчетов по индексации прайс-листа.
downloadTime (optional)
Date Дата и время загрузки прайс-листа.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
format: date-time
fileTime (optional)
Date Дата и время, которые магазин указал в прайс-листе.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
format: date-time
generationId (optional)
Long Идентификатор индексации. format: int64
indexType (optional)
publishedTime (optional)
Date Дата и время публикации предложений из прайс-листа на Яндекс Маркете.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
format: date-time
status (optional)
error (optional)
offers (optional)
Результат выполнения запроса отчета по индексации прайс-листа.
feed (optional)
indexLogRecords
total (optional)
Long Количество отчетов на всех страницах выходных данных. format: int64
Статус индексации прайс-листа и проверки на соответствие техническим требованиям.
Возможные значения:
ERROR — произошли ошибки.OK — обработан без ошибок.WARNING — наблюдались некритичные проблемы.
Параметр прайс-листа.
deleted (optional)
Boolean Удалить ли значение параметра.
Возможное значение:
true — удалить значение параметра.
Используется вместе с параметром name.
name
String Название параметра.
Возможное значение:
reparseIntervalMinutes — период скачивания прайс-листа.
Маркет будет скачивать прайс-лист через количество минут, указанное в параметре value. Например, при value=1440, Маркет будет скачивать прайс-лист один раз в сутки.
{% note alert %}
Несмотря на установленное значение, Маркет скачает прайс-лист один раз в сутки.
{% endnote %}
Обязательный параметр.
values (optional)
array[Integer] Значения параметра.
Используется вместе с параметром name.
format: int32
Информация о размещении предложений из прайс-листа на Маркете на момент выполнения запроса.
status (optional)
totalOffersCount (optional)
Integer Количество предложений из прайс-листа, которые размещаются на Яндекс Маркете в момент выполнения запроса. format: int32
Информация о последней публикации предложений из прайс-листа на Маркете.
status (optional)
full (optional)
priceAndStockUpdate (optional)
Информация о последней публикации предложений из прайс-листа на Маркете.
fileTime (optional)
Date Дата и время, которые магазин указал в прайс-листе.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
format: date-time
publishedTime (optional)
Date Дата и время публикации предложений из прайс-листа на Маркете.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
format: date-time
Последнее обновление цен и наличия товаров на Маркете.
Если последнее по времени обновление было полным, в параметре выводятся те же данные, что и в параметре full.
Выводится, если параметр publication status=OK.
fileTime (optional)
Date Дата и время, которые магазин указал в прайс-листе.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
format: date-time
publishedTime (optional)
Date Дата и время публикации предложений из прайс-листа на Маркете.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.
format: date-time
Статус прайс-листа.
Возможные значения:
ERROR — найдены ошибки.NA — прайс-лист не загружался более семи дней или на этапе загрузки произошла ошибка.OK — ошибок не найдено.
Информация об авторе отзыва.
Если отзыв оставлен анонимно, параметр не возвращается.
name (optional)
region (optional)
Информация об авторе комментария.
type (optional)
name (optional)
String Имя автора отзыва или название магазина.
Тип автора:
USER — пользователь.SHOP — магазин.
Комментарий к отзыву на магазин.
id (optional)
Long Идентификатор ответа. format: int64
parentId (optional)
Long Идентификатор родительского ответа. format: int64
body (optional)
createdAt (optional)
Date Дата и время создания ответа.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:00:00+03:00.
format: date-time
updatedAt (optional)
Date Дата и время изменения ответа.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:00:00+03:00.
format: date-time
author (optional)
children (optional)
Отзыв пользователя Яндекс Маркета об указанном магазине.
id (optional)
Long Идентификатор отзыва. format: int64
createdAt (optional)
Date Дата и время создания отзыва.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:00:00+03:00.
format: date-time
text (optional)
String Комментарий автора отзыва.
state (optional)
author (optional)
pro (optional)
String Достоинства магазина, описанные в отзыве.
contra (optional)
String Недостатки магазина, описанные в отзыве.
comments
shop (optional)
resolved (optional)
Boolean Решена ли проблема автора отзыва:
Если проблема решена, около отзыва на странице магазина появляется соответствующая надпись.
verified (optional)
Boolean {% note warning "" %}
Этот параметр устарел. Не используйте его.
{% endnote %}
Является ли отзыв рекомендованным:
recommend (optional)
Boolean Купил бы автор отзыва в магазине снова:
grades (optional)
order (optional)
Способ покупки, указанный в отзыве:
DELIVERY — доставка.PICKUP — самовывоз.INSTORE — в магазине.
Информация об оценках по параметрам, указанных в отзыве.
При создании отзыва автору предлагается поставить оценки магазину по нескольким параметрам: например, за скорость обработки заказа или удобство самовывоза. Набор параметров зависит от того, какой способ покупки (параметр delivery) указал автор.
id (optional)
Long Идентификатор параметра. format: int64
title (optional)
String Название параметра. Например,
Скорость обработки заказа.
description (optional)
String Описание параметра. Например,
Как быстро с вами связались для подтверждения заказа?.
value (optional)
Integer Оценка по параметру, указанная в отзыве: от
1 (низшая оценка) до
5 (высшая оценка). format: int32
Информация об оценках, которые поставил автор отзыва магазину, и об оценках полезности отзыва от других пользователей Маркета.
average (optional)
BigDecimal Общая оценка, указанная в отзыве: от
1 («Ужасный магазин») до
5 («Отличный магазин»).
agreeCount (optional)
Long Количество пользователей, считающих отзыв полезным. format: int64
rejectCount (optional)
Long Количество пользователей, считающих отзыв бесполезным. format: int64
factors
array[FeedbackFactorDTO] Информация об оценках по параметрам, указанных в отзыве.
При создании отзыва автору предлагается поставить оценки магазину по нескольким параметрам: например, за скорость обработки заказа или удобство самовывоза. Набор параметров зависит от того, какой способ покупки (параметр delivery) указал автор.
Отзывы пользователей Яндекс Маркета об указанном магазине.
paging (optional)
feedbackList
Информация о заказе, указанная в отзыве.
shopOrderId (optional)
String Номер заказа, указанный в отзыве.
delivery (optional)
Статус отзыва:
LAST — актуален.PREVIOUS — устарел.DELETED — удален.
Фильтр по заполненности или незаполненности поля:
SPECIFIED — вывести товары, у которых поле заполнено.EMPTY — вывести товары, у которых поле не заполнено.
Модель для пагинации.
total (optional)
Integer Сколько всего найдено элементов. format: int32
from (optional)
Integer Начальный номер найденного элемента на странице. format: int32
to (optional)
Integer Конечный номер найденного элемента на странице. format: int32
currentPage (optional)
Integer Текущая страница. format: int32
pagesCount (optional)
Integer Общее количество страниц. format: int32
pageSize (optional)
Integer Размер страницы. format: int32
Ссылка на следующую страницу.
nextPageToken (optional)
String Идентификатор следующей страницы результатов.
Склад Маркета (FBY).
id
Long Идентификатор склада. format: int64
name
address (optional)
Список складов Маркета (FBY).
Информация о точке продаж.
name
type
coords (optional)
String Координаты точки продаж.
Формат: долгота, широта. Разделители: запятая и / или пробел. Например, 20.4522144, 54.7104264.
Если параметр не передан, координаты будут определены по значениям параметров, вложенных в address.
isMain (optional)
Boolean Признак основной точки продаж.
Возможные значения:
false — неосновная точка продаж.true — основная точка продаж.
shopOutletCode (optional)
String Идентификатор точки продаж, присвоенный магазином.
visibility (optional)
address
phones
array[String] Номера телефонов точки продаж. Передавайте в формате:
+7 (999) 999-99-99.
workingSchedule
deliveryRules (optional)
array[OutletDeliveryRuleDTO] Информация об условиях доставки для данной точки продаж.
Обязательный параметр, если параметр type=DEPOT или type=MIXED.
storagePeriod (optional)
Long Срок хранения заказа в собственном пункте выдачи заказов. Считается в днях. format: int64
id (optional)
Long Идентификатор точки продаж, присвоенный Маркетом. format: int64
status (optional)
region (optional)
shopOutletId (optional)
String Идентификатор точки продаж, заданный магазином.
workingTime (optional)
moderationReason (optional)
Информация о лицензии.
id (optional)
Long Идентификатор лицензии.
Параметр указывается, только если нужно изменить информацию о существующей лицензии. Ее идентификатор можно узнать с помощью запроса GET campaigns/{campaignId}/outlets/licenses. При передаче информации о новой лицензии указывать идентификатор не нужно.
Идентификатор лицензии присваивается Маркетом. Не путайте его с номером, указанным на лицензии: он передается в параметре number.
format: int64
outletId (optional)
Long Идентификатор точки продаж, для которой действительна лицензия. format: int64
licenseType (optional)
number (optional)
dateOfIssue (optional)
Date Дата выдачи лицензии.
Формат даты: ISO 8601 со смещением относительно UTC. Нужно передать дату, указанную на лицензии, время 00:00:00 и часовой пояс, соответствующий региону точки продаж. Например, если лицензия для точки продаж в Москве выдана 13 ноября 2017 года, то параметр должен иметь значение 2017-11-13T00:00:00+03:00.
Обязательный параметр.
Не может быть позже даты окончания срока действия, указанной в параметре dateOfExpiry.
format: date-time
dateOfExpiry (optional)
Date Дата окончания действия лицензии.
Формат даты: ISO 8601 со смещением относительно UTC. Нужно передать дату, указанную на лицензии, время 00:00:00 и часовой пояс, соответствующий региону точки продаж. Например, если действие лицензии для точки продаж в Москве заканчивается 20 ноября 2022 года, то параметр должен иметь значение 2022-11-20T00:00:00+03:00.
Обязательный параметр.
Не может быть раньше даты выдачи, указанной в параметре dateOfIssue.
format: date-time
checkStatus (optional)
checkComment (optional)
String Причина, по которой лицензия не прошла проверку.
Параметр возвращается, только если параметр checkStatus имеет значение FAIL.
Данные, необходимые для генерации отчета.
businessId
Long Идентификатор бизнеса. format: int64
dateFrom
date Начало периода, включительно. format: date
dateTo
date Конец периода, включительно. format: date
Данные, необходимые для генерации отчета.
businessId
Long Идентификатор бизнеса. format: int64
categoryId
Long Идентификатор категории. format: int64
dateFrom
date Начало периода, включительно. format: date
dateTo
date Конец периода, включительно. format: date
Данные, необходимые для генерации отчета.
businessId
Long Идентификатор бизнеса. format: int64
Данные, необходимые для генерации отчета.
campaignId
Long Идентификатор кампании. format: int64
dateFrom
date Начало периода, включительно. format: date
dateTo
date Конец периода, включительно. format: date
shopSku (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
Данные, необходимые для генерации отчета: идентификатор магазина и период, за который нужен отчет.
campaignId
Long Идентификатор кампании. format: int64
year
month
Integer Номер месяца. format: int32
Данные, необходимые для генерации отчета.
campaignId
Long Идентификатор кампании. format: int64
date (optional)
date Дата, за которую нужно рассчитать оборачиваемость. Если параметр не указан, используется текущая дата. format: date
Данные, необходимые для генерации файла.
businessId
Long Идентификатор кабинета. format: int64
orderIds
set[Long] Список идентификаторов заказов. format: int64
Данные, необходимые для генерации отчета.
businessId (optional)
Long Идентификатор бизнеса.
В большинстве случаев обязателен. Не указывается, если задан campaignId.
format: int64
campaignId (optional)
Long Идентификатор кампании.
Как правило, не используется. Передавайте только если в кабинете есть магазины с уникальными ценами и вы хотите получить отчет для них. В этом случае передавать businessId не нужно.
format: int64
categoryIds (optional)
array[Long] Фильтр по категориям на Маркете. format: int64
creationDateFrom (optional)
date Фильтр по времени появления предложения — начало периода.
Формат даты: ДД-ММ-ГГГГ.
format: date
creationDateTo (optional)
date Фильтр по времени появления предложения — окончание периода.
Формат даты: ДД-ММ-ГГГГ.
format: date
Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета.
reportId
String Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета.
estimatedGenerationTime
Long Ожидаемая продолжительность генерации в миллисекундах. format: int64
Ответ на запрос генерации отчета.
status (optional)
result (optional)
Данные, необходимые для генерации отчета.
businessId
Long Идентификатор бизнеса. format: int64
dateFrom
date Начало периода, включительно. format: date
dateTo
date Конец периода, включительно. format: date
attributionType
Данные, необходимые для генерации документа.
campaignId
Long Идентификатор кампании. format: int64
shipmentId (optional)
Long Идентификатор отгрузки. format: int64
orderIds (optional)
array[Long] Фильтр по идентификаторам заказа в отгрузке. format: int64
Данные, необходимые для генерации отчета.
businessId (optional)
Long Идентификатор бизнеса.
Указывается, если нужно составить отчет по всем магазинам бизнеса. В запросе обязательно должен быть либо businessID, либо campaignId, но не оба сразу.
format: int64
campaignId (optional)
Long Идентификатор кампании.
Указывается, если нужно составить отчет по конкретному магазину. В запросе обязательно должен быть либо businessID, либо campaignId, но не оба сразу.
format: int64
dateFrom
date Начало периода, включительно. format: date
dateTo
date Конец периода, включительно. format: date
grouping
Данные, необходимые для генерации отчета.
campaignId
Long Идентификатор магазина. format: int64
warehouseIds (optional)
array[Long] Фильтр по идентификаторам складов (только модель FBY). Чтобы узнать идентификатор, воспользуйтесь запросом
GET warehouses. format: int64
reportDate (optional)
date Фильтр по дате (для модели FBY). В отчет попадут данные за
предшествующий дате день. format: date
categoryIds (optional)
array[Long] Фильтр по категориям на Маркете (кроме модели FBY). format: int64
hasStocks (optional)
Boolean Фильтр по наличию остатков (кроме модели FBY).
Данные, необходимые для генерации отчета: идентификатор магазина, период, за который нужен отчет, а также фильтры.
businessId
Long Идентификатор бизнеса. format: int64
dateTimeFrom (optional)
Date {% note warning "" %}
Этот параметр устарел. Не используйте его.
{% endnote %}
Начало периода, включительно.
format: date-time
dateTimeTo (optional)
Date {% note warning "" %}
Этот параметр устарел. Не используйте его.
{% endnote %}
Конец периода, включительно. Максимальный период — 1 год.
format: date-time
dateFrom (optional)
date Начало периода, включительно. format: date
dateTo (optional)
date Конец периода, включительно. Максимальный период — 1 год. format: date
yearFrom (optional)
Integer Начальный год формирования акта. format: int32
monthFrom (optional)
Integer Начальный номер месяца формирования акта. format: int32
yearTo (optional)
Integer Конечный год формирования акта. format: int32
monthTo (optional)
Integer Конечный номер месяца формирования акта. format: int32
placementPrograms (optional)
inns (optional)
campaignIds (optional)
array[Long] Список магазинов, которые нужны в отчете. format: int64
Данные, необходимые для генерации отчета: идентификатор магазина, период, за который нужен отчет, а также фильтры.
businessId
Long Идентификатор бизнеса. format: int64
dateTimeFrom (optional)
Date {% note warning "" %}
Этот параметр устарел. Не используйте его.
{% endnote %}
Начало периода, включительно.
format: date-time
dateTimeTo (optional)
Date {% note warning "" %}
Этот параметр устарел. Не используйте его.
{% endnote %}
Конец периода, включительно. Максимальный период — 1 год.
format: date-time
dateFrom (optional)
date Начало периода, включительно. format: date
dateTo (optional)
date Конец периода, включительно. Максимальный период — 1 год. format: date
bankOrderId (optional)
Long Номер платежного поручения. format: int64
bankOrderDateTime (optional)
Date Дата платежного поручения. format: date-time
placementPrograms (optional)
inns (optional)
campaignIds (optional)
array[Long] Список магазинов, которые нужны в отчете. format: int64
Данные, необходимые для генерации отчета.
businessId
Long Идентификатор бизнеса. format: int64
dateFrom
date Начало периода, включительно. format: date
dateTo
date Конец периода, включительно. Максимальный период — 1 год. format: date
campaignIds (optional)
array[Long] Список магазинов, которые нужны в отчете. format: int64
promoId (optional)
String Идентификатор акции, товары из которой нужны в отчете.
description.
skus (optional)
array[String] Список товаров, для которых нужно получить значения ставок.
Если список не задан, постранично возвращаются все товары со ставками.
Если список задан, результаты возвращаются одной страницей, а параметры page_token и limit игнорируются.
description.
status (optional)
result (optional)
Список товаров с указанными ставками.
description.
skus
array[String] Список товаров, для которых нужно получить рекомендации по ставкам.
description.
status (optional)
result (optional)
Список товаров с рекомендованными ставками.
status (optional)
result (optional)
status (optional)
result (optional)
Информация о кабинете и его настройках.
info (optional)
settings (optional)
Ответ на запрос настроек кабинета.
status (optional)
result (optional)
Ответ на запрос списка логинов, связанных с магазином.
Параметры размещения товара в магазине.
offerId
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
quantum (optional)
available (optional)
basicPrice (optional)
campaignPrice (optional)
status (optional)
errors (optional)
warnings (optional)
Фильтрации товаров
В запросе можно указать либо фильтр offerIds, либо любые другие фильтры товаров. Совместное использование фильтра offerIds с другими фильтрациями приведет к ошибке.
offerIds (optional)
array[String] Идентификаторы товаров, информация о которых нужна.
{% note warning "Такой список возвращается только целиком" %}
Не используйте это поле одновременно с фильтрами по статусам карточек, категориям, брендам или тегам. Если вы хотите воспользоваться фильтрами, оставьте поле пустым.
Если вы запрашиваете информацию по конкретным SKU, не заполняйте:
{% endnote %}
statuses (optional)
categoryIds (optional)
vendorNames (optional)
tags (optional)
Ответ на запрос списка товаров в магазине.
status (optional)
result (optional)
Список товаров в заданном магазине.
Ответ на запрос региона магазина.
Информация о магазине к данным идентификатора кампании.
Ответ на запрос настроек магазина.
Результаты поиска магазинов.
campaigns
pager (optional)
Категории и лимит на установку кванта и минимального количества товаров.
results
errors (optional)
Список категорий, для которых нужно вернуть лимит на установку кванта и минимального количества товаров.
marketCategoryIds
set[Long] Идентификаторы листовых категории на Маркете — тех, у которых нет дочерних категорий. format: int64
status (optional)
results
errors (optional)
Параметры запроса категорий.
status (optional)
result (optional)
Ответ со списком характеристик для категории и их допустимыми значениями.
status (optional)
result (optional)
Историю какого чата нужно получить — и начиная с какого сообщения.
messageIdFrom (optional)
Long Идентификатор сообщения, начиная с которого нужно получить все последующие сообщения. format: int64
status (optional)
result (optional)
Информация о чатах.
chatId
Long Идентификатор чата. format: int64
orderId
Long Идентификатор заказа. format: int64
type
status
createdAt
Date Дата и время создания чата.
Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:00:00+03:00.
format: date-time
updatedAt
Date Дата и время последнего сообщения в чате. format: date-time
Фильтры по чатам, которые нужно вернуть.
orderIds (optional)
array[Long] Фильтр по идентификаторам заказов на Маркете. format: int64
types (optional)
statuses (optional)
status (optional)
result (optional)
Ответ на запрос списка служб доставки.
status (optional)
result (optional)
Ответ на запрос информации о прайс-листе.
status (optional)
result (optional)
Ответ на запрос списка прайс-листов.
status (optional)
result (optional)
Фильтр запроса комментариев отзыва.
feedbackId
Long Идентификатор отзыва. format: int64
status (optional)
result (optional)
Фильтр запроса отзывов в кабинете.
dateTimeFrom (optional)
Date Начало периода. Не включительно.
Если параметр не указан, возвращается информация за 6 месяцев до указанной в dateTimeTo даты.
format: date-time
dateTimeTo (optional)
Date Конец периода. Не включительно.
Если параметр не указан, используется текущая дата.
format: date-time
reactionStatus (optional)
ratingValues (optional)
modelIds (optional)
set[Long] Фильтр по идентификатору модели товара.
Получить идентификатор модели можно с помощью одного из запросов:
format: int64
paid (optional)
Boolean Фильтр отзывов за баллы Плюса.
status (optional)
result (optional)
Запрос отчета по товарам.
Ответ на запрос отчета по товарам.
status (optional)
result (optional)
Ответ на запрос списка скрытий.
status (optional)
result (optional)
Список скрытых вами товаров.
paging (optional)
hiddenOffers
Информация о товарах в каталоге.
marketSku (optional)
Long SKU на Маркете. format: int64
marketSkuName (optional)
String Название карточки товара.
Может отсутствовать в ответе, если товар еще не привязан к карточке.
marketModelId (optional)
Long Идентификатор модели на Маркете.
Может отсутствовать в ответе, если товар еще не привязан к карточке.
format: int64
marketModelName (optional)
String Название модели на Маркете.
Может отсутствовать в ответе, если товар еще не привязан к карточке.
marketCategoryId (optional)
Long Идентификатор категории на Маркете, в которую попал товар.
Может отсутствовать в ответе, если Маркет еще не определил категорию товара.
format: int64
marketCategoryName (optional)
String Название категории карточки на Маркете.
Может отсутствовать в ответе, если Маркет еще не определил категорию товара.
Ответ на запрос списка предложений для моделей.
models
currency (optional)
regionId (optional)
Long Идентификатор региона, для которого выводится информация о предложениях модели (доставляемых в этот регион).
Информацию о регионе по идентификатору можно получить с помощью запроса GET regions/{regionId}.
format: int64
Запрос информации о моделях.
Ответ на запрос информации о моделях.
models
currency (optional)
regionId (optional)
Long Идентификатор региона, для которого выводится информация о предложениях модели (доставляемых в этот регион).
Информацию о регионе по идентификатору можно получить с помощью запроса GET regions/{regionId}.
format: int64
offerIds (optional)
set[String] Идентификаторы товаров, информация о которых нужна.
⚠️ Не используйте это поле одновременно с фильтрами по статусам карточек, категориям, брендам или тегам. Если вы хотите воспользоваться фильтрами, оставьте поле пустым.
cardStatuses (optional)
categoryIds (optional)
Ответ со списком состояний товаров и пагинацией.
status (optional)
result (optional)
Параметры товара.
offerId
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
name (optional)
String Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке.
Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей.
Оптимальная длина — 50–60 символов, максимальная — 256.
Рекомендации и правила
marketCategoryId (optional)
Long Идентификатор категории на Маркете, к которой вы относите свой товар.
Если не указать marketCategoryId, то маркетная категория будет определена автоматически.
При изменении информации о товаре передавайте тот же идентификатор категории. Если вы укажете другой, категория товара не поменяется. Изменить ее можно только в кабинете продавца на Маркете.
Список категорий Маркета можно получить с помощью запроса POST categories/tree.
format: int64
category (optional)
String Категория товара в вашем магазине. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.
Указывайте конкретные категории — например, набор ножей лучше отнести к категории Столовые приборы, а не просто Посуда.
Выбирайте категории, которые описывают товар, а не абстрактный признак — например, Духи, а не Подарки.
Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.
pictures (optional)
array[String] Ссылки на изображения товара. Изображение по первой ссылке считается основным, остальные дополнительными.
Требования к ссылкам
- Ссылок может быть до 30.
- Указывайте ссылку целиком, включая протокол http или https.
- Максимальная длина — 512 символов.
- Русские буквы в URL можно.
- Можно использовать прямые ссылки на изображения и на Яндекс Диск. Ссылки на Яндекс Диске нужно копировать с помощью функции Поделиться. Относительные ссылки и ссылки на другие облачные хранилища — не работают.
✅ https://example-shop.ru/images/sku12345.jpg
✅ https://yadi.sk/i/NaBoRsimVOLov
❌ /images/sku12345.jpg
❌ https://www.dropbox.com/s/818f/tovar.jpg
Ссылки на изображение должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке.
Если нужно заменить изображение, выложите новое изображение по новой ссылке, а ссылку на старое удалите. Если просто заменить изображение по старой ссылке, оно не обновится.
Требования к изображениям
videos (optional)
array[String] Ссылка (URL) на видео товара.
Максимальное количество ссылок — 6.
Требования к ссылке
- Указывайте ссылку целиком, включая протокол http или https.
- Максимальная длина — 512 символов.
- Русские буквы в URL можно.
- Можно использовать прямые ссылки на видео и на Яндекс Диск. Ссылки на Яндекс Диске нужно копировать с помощью функции Поделиться. Относительные ссылки и ссылки на другие облачные хранилища — не работают.
✅ https://example-shop.ru/video/sku12345.avi
✅ https://yadi.sk/i/NaBoRsimVOLov
❌ /video/sku12345.avi
❌ https://www.dropbox.com/s/818f/super-tovar.avi
Ссылки на видео должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке.
Если нужно заменить видео, выложите новое видео по новой ссылке, а ссылку на старое удалите. Если просто заменить видео по старой ссылке, оно не обновится.
Требования к видео
manuals (optional)
array[OfferManualDTO] Список инструкций по использованию товара.
Максимальное количество инструкций — 6.
Если вы передадите пустое поле manuals, загруженные ранее инструкции удалятся.
vendor (optional)
String Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.
barcodes (optional)
array[String] Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128.
Для книг указывайте ISBN.
Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN.
Что такое GTIN
description (optional)
String Подробное описание товара: например, его преимущества и особенности.
Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок.
Можно использовать теги:
- <h>, <h1>, <h2> и так далее — для заголовков;
- <br> и <p> — для переноса строки;
- <ol> — для нумерованного списка;
- <ul> — для маркированного списка;
- <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>);
- <div> — поддерживается, но не влияет на отображение текста.
Оптимальная длина — 400–600 символов, максимальная — 6000.
Рекомендации и правила
manufacturerCountries (optional)
array[String] Страна, где был произведен товар.
Записывайте названия стран так, как они записаны в списке.
weightDimensions (optional)
vendorCode (optional)
String Артикул товара от производителя.
tags (optional)
array[String] Метки товара, используемые магазином. Покупателям теги не видны. По тегам можно группировать и фильтровать разные товары в каталоге — например, товары одной серии, коллекции или линейки.
Максимальная длина тега 20 символов. У одного товара может быть максимум 10 тегов. Всего можно создать не больше 50 разных тегов.
shelfLife (optional)
lifeTime (optional)
guaranteePeriod (optional)
customsCommodityCode (optional)
String Код товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД) — 10 или 14 цифр без пробелов.
Обязательно укажите, если он есть.
certificates (optional)
array[String] Номера документов на товар: сертификата, декларации соответствия и т. п.
Передавать можно только номера документов, сканы которого загружены в кабинете продавца по инструкции.
boxCount (optional)
Integer Количество грузовых мест.
Параметр используется, если товар представляет собой несколько коробок, упаковок и так далее. Например, кондиционер занимает два места — внешний и внутренний блоки в двух коробках.
Для товаров, занимающих одно место, не передавайте этот параметр.
format: int32
condition (optional)
type (optional)
downloadable (optional)
adult (optional)
Boolean Параметр включает для товара пометку 18+. Устанавливайте ее только для товаров, которые относятся к удовлетворению сексуальных потребностей.
age (optional)
params (optional)
array[OfferParamDTO] {% note warning "" %}
Этот параметр устарел. При передаче характеристик используйте parameterValues.
{% endnote %}
Характеристики, которые есть только у товаров конкретной категории — например, диаметр колес велосипеда или материал подошвы обуви.
basicPrice (optional)
purchasePrice (optional)
additionalExpenses (optional)
cofinancePrice (optional)
cardStatus (optional)
campaigns (optional)
sellingPrograms (optional)
archived (optional)
Информация о товаре.
offer (optional)
mapping (optional)
Ответ на запрос списка товаров в каталоге.
status (optional)
result (optional)
offerIds (optional)
array[String] Идентификаторы товаров, информация о которых нужна.
{% note warning "Такой список возвращается только целиком" %}
Если вы запрашиваете информацию по конкретным SKU, не заполняйте:
page_token;limit;cardStatuses;categoryIds;vendorNames;tags;archived.
{% endnote %}
cardStatuses (optional)
categoryIds (optional)
vendorNames (optional)
tags (optional)
archived (optional)
Boolean Фильтр по нахождению в архиве.
Передайте true, чтобы получить товары, находящиеся в архиве. Если фильтр не заполнен или передано false, в ответе возвращаются товары, не находящиеся в архиве.
status (optional)
result (optional)
Информация о товарах.
paging (optional)
offerMappings
offerIds (optional)
array[String] Идентификаторы товаров, информация о которых нужна. ⚠️ Не используйте это поле одновременно с остальными фильтрами. Если вы хотите воспользоваться фильтрами, оставьте поле пустым.
cofinancePriceFilter (optional)
recommendedCofinancePriceFilter (optional)
competitivenessFilter (optional)
status (optional)
result (optional)
Список предложений с пагинатором.
status (optional)
result (optional)
Ответ с информацией для печати ярлыков.
status (optional)
result (optional)
Модель для ответа API списка информации по заказам.
pager (optional)
orders
paging (optional)
Запрос информации по заказам.
dateFrom (optional)
date Начальная дата, когда заказ был сформирован.
Формат даты: ГГГГ‑ММ‑ДД.
Нельзя использовать вместе с параметрами updateFrom и updateTo.
format: date
dateTo (optional)
date Конечная дата, когда заказ был сформирован.
Формат даты: ГГГГ‑ММ‑ДД.
Нельзя использовать вместе с параметрами updateFrom и updateTo.
format: date
updateFrom (optional)
date Начальная дата периода, за который были изменения статуса заказа.
Формат даты: ГГГГ‑ММ‑ДД.
Нельзя использовать вместе с параметрами dateFrom и dateTo.
format: date
updateTo (optional)
date Конечная дата периода, за который были изменения статуса заказа.
Формат даты: ГГГГ‑ММ‑ДД.
Нельзя использовать вместе с параметрами dateFrom и dateTo.
format: date
orders (optional)
array[Long] Список идентификаторов заказов. format: int64
statuses (optional)
hasCis (optional)
Boolean Нужно ли вернуть только те заказы, в составе которых есть хотя бы один товар с кодом идентификации в системе «Честный ЗНАК»:
true — да.false — нет.
Такие коды присваиваются товарам, которые подлежат маркировке и относятся к определенным категориям.
Ответ на запрос информации по заказам.
status (optional)
result (optional)
status (optional)
result (optional)
Ответ на запрос информации о точке продаж.
Ответ на запрос информации о точках продаж.
outlets
paging (optional)
pager (optional)
Цена с указанием времени последнего обновления.
value
currencyId
updatedAt
Date Время последнего обновления. format: date-time
Цена с указанием скидки и времени последнего обновления.
value
currencyId
discountBase (optional)
BigDecimal Цена до скидки.
Число должно быть целым. Вы можете указать цену со скидкой от 5 до 99%.
Передавайте этот параметр при каждом обновлении цены, если предоставляете скидку на товар.
updatedAt
Date Время последнего обновления. format: date-time
Цена с указанием ставки НДС и времени последнего обновления.
value (optional)
discountBase (optional)
BigDecimal Цена на товар без скидки.
Число должно быть целым. Вы можете указать цену со скидкой от 5 до 99%.
Передавайте этот параметр при каждом обновлении цены, если предоставляете скидку на товар.
currencyId (optional)
vat (optional)
Integer Идентификатор ставки НДС, применяемой для товара:
2 — 10%.5 — 0%.6 — не облагается НДС.7 — 20%.
Если параметр не указан, используется ставка НДС, установленная в кабинете.
format: int32
updatedAt
Date Время последнего обновления. format: date-time
Запрос списка цен.
offerIds (optional)
array[String] Список SKU.
{% note warning "Такой список возвращается только целиком" %}
Если вы запрашиваете информацию по конкретным SKU, не заполняйте:
{% endnote %}
Ответ на запрос списка цен.
status (optional)
result (optional)
Ответ на запрос списка цен.
status (optional)
result (optional)
Информация о товарах в акции.
activeOffers
Integer Количество товаров, которые участвуют или участвовали в акции.
Учитываются только товары, которые были добавлены вручную.
Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.
format: int32
potentialOffers (optional)
Integer Количество доступных товаров в акции.
Параметр возвращается только для текущих и будущих акций.
format: int32
processing (optional)
Boolean Есть ли изменения в ассортименте, которые еще не применились. Сохранение изменений занимает некоторое время.
Параметр возвращается только для текущих и будущих акций.
Информация об акции «Бестселлеры Маркета».
bestseller
entryDeadline (optional)
Date До какой даты можно добавить товар в акцию «Бестселлеры Маркета».
Параметр возвращается только для текущих и будущих акций «Бестселлеры Маркета».
format: date-time
Ограничения в акции.
warehouseIds (optional)
array[Long] Идентификаторы складов, для которых действует акция. Товары, которые лежат на других складах, не будут продаваться по акции.
Параметр возвращается, только если в условиях акции есть ограничение по складу.
format: int64
Информация об акции.
id
name
period
participating
Boolean Участвует или участвовал ли продавец в этой акции.
Для текущих и будущих акций возвращается со значением true, если в акции есть товары, которые были добавлены вручную. Если товары не участвуют в акции или добавлены в нее автоматически, параметр возвращается со значением false.
Для прошедших акций всегда возвращается со значением true.
Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.
assortmentInfo
mechanicsInfo
bestsellerInfo
channels (optional)
constraints (optional)
Информация о типе акции.
type
promocodeInfo (optional)
Товар, который участвует или может участвовать в акции.
offerId
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
status
params
autoParticipatingDetails (optional)
Получение списка товаров, которые участвуют или могут участвовать в акции.
promoId
statusType (optional)
status (optional)
result (optional)
Список товаров, которые участвуют или могут участвовать в акции.
Информация для типа MARKET_PROMOCODE.
Параметр заполняется только для этого типа акции.
promocode
discount
Integer Процент скидки по промокоду. format: int32
Фильтры для получения списка акций.
participation (optional)
mechanics (optional)
status (optional)
result (optional)
Информация об акциях Маркета.
status (optional)
result (optional)
Запрос информации по индексу качества.
dateFrom (optional)
date Начало периода.
Формат даты: ГГГГ‑ММ‑ДД.
Не может быть раньше 30 дней от текущей даты.
format: date
dateTo (optional)
date Конец периода.
Формат даты: ГГГГ‑ММ‑ДД.
Не может быть позже текущей даты.
format: date
campaignIds
set[Long] Список идентификаторов магазинов. format: int64
Информация об индексе качества магазинов.
status (optional)
result (optional)
Фильтрации товаров
В запросе можно указать либо фильтр offerIds, либо любые другие фильтры товаров. Совместное использование фильтра offerIds с другими фильтрациями приведет к ошибке.
offerIds (optional)
array[String] Идентификаторы товаров, информация о которых нужна.
⚠️ Не используйте это поле одновременно с фильтрами по статусам карточек, категориям, брендам или тегам. Если вы хотите воспользоваться фильтрами, оставьте поле пустым.
cardStatuses (optional)
categoryIds (optional)
vendorNames (optional)
tags (optional)
Ответ на запрос списка товаров в карантине.
status (optional)
result (optional)
Список товаров в карантине.
pager (optional)
regions (optional)
regions
paging (optional)
Ответ на запрос информации об отчете.
status (optional)
result (optional)
status (optional)
result (optional)
status (optional)
result (optional)
status (optional)
result (optional)
status (optional)
result (optional)
Запрос рекомендованных карточек товара.
Ответ со списком рекомендованных карточек товара.
status (optional)
result (optional)
status (optional)
result (optional)
Подобранные карточки на Маркете.
Список складов с информацией об остатках на каждом из них.
paging (optional)
warehouses
Фильтры для запроса остатков.
withTurnover (optional)
Boolean Только для модели FBY
Возвращать ли информацию по оборачиваемости.
Значение по умолчанию — false. Если информация нужна, передайте значение true.
archived (optional)
Boolean Фильтр по нахождению в архиве.
Передайте true, чтобы получить информацию об остатках товаров, которые находятся в архиве. Если фильтр не заполнен или передано false, в ответе возвращается информация о товарах, которые не находятся в архиве.
offerIds (optional)
set[String] Фильтр по вашим SKU товаров.
Возвращается информация об остатках всех переданных SKU, включая товары в архиве.
{% note warning "Такой список возвращается только целиком" %}
Если вы запрашиваете информацию по конкретным SKU, не заполняйте:
page_tokenlimitarchived
{% endnote %}
status (optional)
result (optional)
status (optional)
result (optional)
Информация об авторе комментария.
type (optional)
name (optional)
String Имя автора или название кабинета.
Тип автора:
USER — пользователь.BUSINESS — кабинет.
Комментарий к отзыву.
id
Long Идентификатор комментария к отзыву. format: int64
text
canModify (optional)
Boolean Может ли продавец изменять комментарий или удалять его.
parentId (optional)
Long Идентификатор комментария к отзыву. format: int64
author
status
Комментарии к отзыву.
comments
paging (optional)
Статус комментария:
PUBLISHED — опубликован.UNMODERATED — не проверен.BANNED — заблокирован.DELETED — удален.
Отзыв о товаре.
feedbackId
Long Идентификатор отзыва. format: int64
createdAt
Date Дата и время создания отзыва. format: date-time
needReaction
identifiers
author (optional)
description (optional)
media (optional)
statistics
Текстовая часть отзыва.
advantages (optional)
String Описание плюсов товара в отзыве.
disadvantages (optional)
String Описание минусов товара в отзыве.
comment (optional)
Идентификаторы, которые связаны с отзывом.
orderId
Long Идентификатор заказа на Маркете. format: int64
modelId
Long Идентификатор модели товара. format: int64
Список отзывов о товарах.
feedbacks
paging (optional)
Фото и видео.
photos (optional)
videos (optional)
Статистическая информация по отзыву.
rating
Integer Оценка товара. format: int32
commentsCount
Long Количество комментариев к отзыву.
Учитываются только ответы на отзывы, а не дочерние комментарии.
format: int64
recommended (optional)
paidAmount (optional)
Long Количество баллов Плюса, которое автор получил за отзыв. format: int64
Информация о товаре.
shopSku (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
marketSku (optional)
Long SKU на Маркете. format: int64
name (optional)
price (optional)
categoryId (optional)
Long Идентификатор категории товара на Маркете. format: int64
categoryName (optional)
String Название категории товара на Маркете.
weightDimensions (optional)
warehouses (optional)
tariffs (optional)
array[TariffDTO] Информация о тарифах, по которым нужно заплатить за услуги Маркета.
По некоторым услугам могут возвращаться несколько разных стоимостей. Например, в модели FBS стоимость услуги SORTING (обработка заказа) зависит от способа отгрузки
и количества заказов в отгрузке. Подробнее о тарифах на услуги читайте в Справке Маркета для продавцов.
pictures (optional)
array[String] Ссылки (URL) изображений товара в хорошем качестве.
Информация о складе.
id (optional)
Long Идентификатор склада. format: int64
name (optional)
stocks
Информация о весе и габаритах товара.
Если товар уже привязан к карточке (marketSku), в ответе вернутся габариты из карточки Маркета, а не размеры, которые вы передаете.
length (optional)
width (optional)
height (optional)
weight (optional)
GPS-координаты широты и долготы.
Информация о скрытии.
offerId
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
Язык:
-
RU — русский.
-
EN — английский.
Статус проверки лицензии:
NEW — лицензия проверяется.SUCCESS — лицензия прошла проверку.FAIL — лицензия не прошла проверку.
Тип лицензии:
ALCOHOL — лицензия на розничную продажу алкогольной продукции.
Описание пункта вывоза для возврата.
id (optional)
Long Идентификатор пункта вывоза. format: int64
name (optional)
String Название пункта вывоза.
address (optional)
instruction (optional)
String Дополнительные инструкции к вывозу.
type (optional)
logisticPartnerId (optional)
Long Идентификатор логистического партнера, к которому относится логистическая точка. format: int64
Тип логистической точки:
WAREHOUSE — склад.PICKUP_POINT — обычная точка выдачи заказов (ПВЗ).PICKUP_TERMINAL — постамат.PICKUP_POST_OFFICE — отделение почтовой связи (ОПС).PICKUP_MIXED — торговый зал и пункт выдачи заказов.PICKUP_RETAIL — торговый зал.
Информация о товарах в каталоге.
name (optional)
String Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке.
Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей.
Оптимальная длина — 50–60 символов, максимальная — 256.
Рекомендации и правила
shopSku (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
category (optional)
String Категория товара в вашем магазине. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.
Указывайте конкретные категории — например, набор ножей лучше отнести к категории Столовые приборы, а не просто Посуда.
Выбирайте категории, которые описывают товар, а не абстрактный признак — например, Духи, а не Подарки.
Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.
vendor (optional)
String Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.
vendorCode (optional)
String Артикул товара от производителя.
description (optional)
String Подробное описание товара: например, его преимущества и особенности.
Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок.
Можно использовать теги:
- <h>, <h1>, <h2> и так далее — для заголовков;
- <br> и <p> — для переноса строки;
- <ol> — для нумерованного списка;
- <ul> — для маркированного списка;
- <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>);
- <div> — поддерживается, но не влияет на отображение текста.
Оптимальная длина — 400–600 символов, максимальная — 6000.
Рекомендации и правила
id (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
feedId (optional)
Long Идентификатор фида. format: int64
barcodes (optional)
array[String] Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128.
Для книг указывайте ISBN.
Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN.
Что такое GTIN
urls (optional)
array[String] URL фотографии товара или страницы с описанием на вашем сайте.
Переданные данные не будут отображаться на витрине, но они помогут специалистам Маркета найти карточку для вашего товара.
Должен содержать один вложенный параметр url.
pictures (optional)
array[String] Ссылки (URL) изображений товара в хорошем качестве.
Можно указать до 30 ссылок. При этом изображение по первой ссылке будет основным. Оно используется в качестве изображения товара в поиске Маркета и на карточке товара. Другие изображения товара доступны в режиме просмотра увеличенных изображений.
Обязательный параметр.
Должен содержать хотя бы один вложенный параметр picture.
manufacturer (optional)
String Изготовитель товара: компания, которая произвела товар, ее адрес и регистрационный номер (если есть).
Необязательный параметр.
manufacturerCountries (optional)
array[String] Список стран, в которых произведен товар.
Обязательный параметр.
Должен содержать хотя бы одну, но не больше 5 стран.
minShipment (optional)
Integer Минимальное количество единиц товара, которое вы поставляете на склад.
Например, если вы поставляете детское питание партиями минимум по 10 коробок, а в каждой коробке по 6 баночек, укажите значение 60.
format: int32
transportUnitSize (optional)
Integer Количество единиц товара в одной упаковке, которую вы поставляете на склад.
Например, если вы поставляете детское питание коробками по 6 баночек, укажите значение 6.
format: int32
quantumOfSupply (optional)
Integer Добавочная партия: по сколько единиц товара можно добавлять к минимальному количеству minShipment.
Например, если вы поставляете детское питание партиями минимум по 10 коробок и хотите добавлять к минимальной партии по 2 коробки, а в каждой коробке по 6 баночек, укажите значение 12.
format: int32
deliveryDurationDays (optional)
Integer Срок, за который продавец поставляет товары на склад, в днях. format: int32
boxCount (optional)
Integer Сколько мест (если больше одного) занимает товар.
Параметр указывается, только если товар занимает больше одного места (например, кондиционер занимает два места: внешний и внутренний блоки в двух коробках). Если товар занимает одно место, не указывайте этот параметр.
format: int32
customsCommodityCodes (optional)
array[String] Список кодов товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД).
Обязательный параметр, если товар подлежит особому учету (например, в системе «Меркурий» как продукция животного происхождения или в системе «Честный ЗНАК»).
Может содержать только один вложенный код ТН ВЭД.
weightDimensions (optional)
supplyScheduleDays (optional)
shelfLifeDays (optional)
Integer {% note warning "" %}
Этот параметр устарел. Вместо него используйте shelfLife. Совместное использование обоих параметров приведет к ошибке.
{% endnote %}
Срок годности: через сколько дней товар станет непригоден для использования.
format: int32
lifeTimeDays (optional)
Integer {% note warning "" %}
Этот параметр устарел. Вместо него используйте lifeTime. Совместное использование обоих параметров приведет к ошибке.
{% endnote %}
Срок службы: сколько дней товар будет исправно выполнять свою функцию, а изготовитель — нести ответственность за его существенные недостатки.
format: int32
guaranteePeriodDays (optional)
Integer Гарантийный срок товара: сколько дней возможно обслуживание и ремонт товара или возврат денег, а изготовитель или продавец будет нести ответственность за недостатки товара. format: int32
processingState (optional)
availability (optional)
shelfLife (optional)
lifeTime (optional)
guaranteePeriod (optional)
certificate (optional)
String Номер документа на товар.
Перед указанием номера документ нужно загрузить в кабинете продавца на Маркете. Инструкция
price (optional)
Базовая информация о товарах в каталоге.
name (optional)
String Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке.
Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей.
Оптимальная длина — 50–60 символов, максимальная — 256.
Рекомендации и правила
shopSku (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
category (optional)
String Категория товара в вашем магазине. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.
Указывайте конкретные категории — например, набор ножей лучше отнести к категории Столовые приборы, а не просто Посуда.
Выбирайте категории, которые описывают товар, а не абстрактный признак — например, Духи, а не Подарки.
Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.
vendor (optional)
String Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.
vendorCode (optional)
String Артикул товара от производителя.
description (optional)
String Подробное описание товара: например, его преимущества и особенности.
Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок.
Можно использовать теги:
- <h>, <h1>, <h2> и так далее — для заголовков;
- <br> и <p> — для переноса строки;
- <ol> — для нумерованного списка;
- <ul> — для маркированного списка;
- <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>);
- <div> — поддерживается, но не влияет на отображение текста.
Оптимальная длина — 400–600 символов, максимальная — 6000.
Рекомендации и правила
id (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
feedId (optional)
Long Идентификатор фида. format: int64
barcodes (optional)
array[String] Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128.
Для книг указывайте ISBN.
Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN.
Что такое GTIN
urls (optional)
array[String] URL фотографии товара или страницы с описанием на вашем сайте.
Переданные данные не будут отображаться на витрине, но они помогут специалистам Маркета найти карточку для вашего товара.
Должен содержать один вложенный параметр url.
pictures (optional)
array[String] Ссылки (URL) изображений товара в хорошем качестве.
Можно указать до 30 ссылок. При этом изображение по первой ссылке будет основным. Оно используется в качестве изображения товара в поиске Маркета и на карточке товара. Другие изображения товара доступны в режиме просмотра увеличенных изображений.
Обязательный параметр.
Должен содержать хотя бы один вложенный параметр picture.
manufacturer (optional)
String Изготовитель товара: компания, которая произвела товар, ее адрес и регистрационный номер (если есть).
Необязательный параметр.
manufacturerCountries (optional)
array[String] Список стран, в которых произведен товар.
Обязательный параметр.
Должен содержать хотя бы одну, но не больше 5 стран.
minShipment (optional)
Integer Минимальное количество единиц товара, которое вы поставляете на склад.
Например, если вы поставляете детское питание партиями минимум по 10 коробок, а в каждой коробке по 6 баночек, укажите значение 60.
format: int32
transportUnitSize (optional)
Integer Количество единиц товара в одной упаковке, которую вы поставляете на склад.
Например, если вы поставляете детское питание коробками по 6 баночек, укажите значение 6.
format: int32
quantumOfSupply (optional)
Integer Добавочная партия: по сколько единиц товара можно добавлять к минимальному количеству minShipment.
Например, если вы поставляете детское питание партиями минимум по 10 коробок и хотите добавлять к минимальной партии по 2 коробки, а в каждой коробке по 6 баночек, укажите значение 12.
format: int32
deliveryDurationDays (optional)
Integer Срок, за который продавец поставляет товары на склад, в днях. format: int32
boxCount (optional)
Integer Сколько мест (если больше одного) занимает товар.
Параметр указывается, только если товар занимает больше одного места (например, кондиционер занимает два места: внешний и внутренний блоки в двух коробках). Если товар занимает одно место, не указывайте этот параметр.
format: int32
customsCommodityCodes (optional)
array[String] Список кодов товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД).
Обязательный параметр, если товар подлежит особому учету (например, в системе «Меркурий» как продукция животного происхождения или в системе «Честный ЗНАК»).
Может содержать только один вложенный код ТН ВЭД.
weightDimensions (optional)
supplyScheduleDays (optional)
shelfLifeDays (optional)
Integer {% note warning "" %}
Этот параметр устарел. Вместо него используйте shelfLife. Совместное использование обоих параметров приведет к ошибке.
{% endnote %}
Срок годности: через сколько дней товар станет непригоден для использования.
format: int32
lifeTimeDays (optional)
Integer {% note warning "" %}
Этот параметр устарел. Вместо него используйте lifeTime. Совместное использование обоих параметров приведет к ошибке.
{% endnote %}
Срок службы: сколько дней товар будет исправно выполнять свою функцию, а изготовитель — нести ответственность за его существенные недостатки.
format: int32
guaranteePeriodDays (optional)
Integer Гарантийный срок товара: сколько дней возможно обслуживание и ремонт товара или возврат денег, а изготовитель или продавец будет нести ответственность за недостатки товара. format: int32
processingState (optional)
availability (optional)
shelfLife (optional)
lifeTime (optional)
guaranteePeriod (optional)
certificate (optional)
String Номер документа на товар.
Перед указанием номера документ нужно загрузить в кабинете продавца на Маркете. Инструкция
Лимит на установку кванта и минимального количества товаров по категориям.
id
Long Идентификатор категории. format: int64
name (optional)
maxSaleQuantum (optional)
Integer Лимит на установку кванта и минимального количества товаров.
Модель товара.
id (optional)
Long Идентификатор модели товара. format: int64
name (optional)
String Название модели товара.
prices (optional)
Информация о предложении.
discount (optional)
Integer Скидка на предложение в процентах. format: int32
name (optional)
String Наименование предложения.
pos (optional)
Integer Позиция предложения в выдаче Маркета на карточке модели. format: int32
preDiscountPrice (optional)
price (optional)
BigDecimal Цена предложения без скидки, которую получает покупатель при оплате через Yandex Pay.
regionId (optional)
Long Идентификатор региона предложения (регион, откуда доставляется товар).
Сначала показываются предложения, доставляемые из региона, указанного в запросе в параметре regionId. Предложения, доставляемые из других регионов, показываются после них.
format: int64
shippingCost (optional)
BigDecimal Стоимость доставки товара в регион:
0 — доставка осуществляется бесплатно.-1 — магазин не осуществляет доставку этого товара (самовывоз).
Если стоимость доставки неизвестна, параметр не выводится.
shopName (optional)
String Название магазина (в том виде, в котором отображается на Маркете).
shopRating (optional)
Integer Рейтинг магазина.
Возможные значения:
-1 — у магазинов, недавно появившихся на Маркете, рейтинг появляется не сразу. До момента появления рейтинга для таких магазинов возвращается значение -1.1.2.3.4.5.
format: int32
inStock (optional)
Integer {% note warning "" %}
Этот параметр устарел. Не используйте его.
{% endnote %}
format: int32
Информация о ценах на модель товара.
avg (optional)
BigDecimal Средняя цена предложения для модели в регионе.
max (optional)
BigDecimal Максимальная цена предложения для модели в регионе.
min (optional)
BigDecimal Минимальная цена предложения для модели в регионе.
Планы по поставкам:
ACTIVE — поставки будут.INACTIVE — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять. Через 60 дней после того, как товар закончится на складе, этот статус изменится на DELISTED.DELISTED — архив: товар закончился на складе, и его поставок больше не будет. Если товар вернется на склад (например, покупатель вернет заказ), этот статус изменится на INACTIVE.
Статус товара в магазине.
campaignId
Long Идентификатор кампании. format: int64
status
Статус товара:
PUBLISHED — Готов к продаже.CHECKING — На проверке.DISABLED_BY_PARTNER — Скрыт вами.REJECTED_BY_MARKET — Отклонен.DISABLED_AUTOMATICALLY — Исправьте ошибки.CREATING_CARD — Создается карточка.NO_CARD — Нужна карточка.NO_STOCKS — Нет на складе.ARCHIVED — В архиве.
Что обозначает каждый из статусов
Информация о состоянии карточки товара.
Если поле mapping отсутствует в ответе, Маркет еще не успел обработать информацию о товаре. Чтобы определить категорию такого товара, повторите запрос через несколько минут.
offerId
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
mapping (optional)
parameterValues (optional)
cardStatus (optional)
contentRating (optional)
Integer Процент заполненности карточки. format: int32
recommendations (optional)
array[OfferCardRecommendationDTO] Список рекомендаций к заполнению карточки.
Рекомендации Маркета помогают заполнять карточку так, чтобы покупателям было проще найти ваш товар и решиться на покупку.
errors (optional)
warnings (optional)
array[OfferErrorDTO] Связанные с контентом предупреждения, не препятствующие размещению товара на витрине.
Рекомендация по заполнению карточки товара.
type
percent (optional)
Integer Процент выполнения рекомендации. Указывается для рекомендаций некоторых типов. format: int32
Рекомендация по дополнению или замене контента. Не возвращается для карточек, которые заполнены Маркетом или содержат бывшие в употреблении товары.
Часть рекомендаций относятся к основным параметрам, которые есть у товаров любых категорий. Другие — к тем характеристикам, которые есть у товара потому, что он относится к определенной категории.
1. Рекомендации, относящиеся к основным параметрам
Каждая такая рекомендация относится к единственному параметру. Чтобы заполнить этот параметр, пользуйтесь запросом POST businesses/{businessId}/offer-mappings/update.
Рекомендации по заполнению параметров в updateOfferMappings:
RECOGNIZED_VENDOR — напишите название производителя так, как его пишет сам производитель (параметр vendor).PICTURE_COUNT — добавьте изображения (параметр pictures).FIRST_PICTURE_SIZE — замените первое изображение более крупным (параметр pictures).TITLE_LENGTH — измените название (параметр name). Составьте название по схеме: тип + бренд или производитель + модель + особенности, если есть (размер, вес, цвет).DESCRIPTION_LENGTH — добавьте описание рекомендуемого размера (параметр description).AVERAGE_PICTURE_SIZE — замените все изображения на изображения высокого качества (параметр pictures).FIRST_VIDEO_LENGTH — добавьте первое видео рекомендуемой длины (параметр videos).AVERAGE_VIDEO_SIZE — замените все видео на видео высокого качества (параметр videos).VIDEO_COUNT — добавьте больше видео (параметр videos).
Рекомендуемые значения параметров описаны в Справке Яндекс Маркета для продавцов.
2. Рекомендации, относящиеся к характеристикам по категориям
Каждая такая рекомендация предполагает заполнение одной или нескольких характеристик. Чтобы узнать, какие именно характеристики нужно заполнить, воспользуйтесь запросом POST category/{categoryId}/parameters. Например, если вы получили рекомендацию MAIN, нужно заполнить характеристики, имеющие MAIN в массиве recommendationTypes.
Рекомендации:
MAIN — заполните ключевые характеристики товара, которые используются в поиске и фильтрах.ADDITIONAL — заполните дополнительные характеристики товара.DISTINCTIVE — заполните характеристики, которыми отличаются друг от друга варианты товара.
3. Устаревшие рекомендации
HAS_VIDEO.FILTERABLE.HAS_DESCRIPTION.HAS_BARCODE.
Статус карточки товара:
HAS_CARD_CAN_NOT_UPDATE — Карточка Маркета.HAS_CARD_CAN_UPDATE — Можно дополнить.HAS_CARD_CAN_UPDATE_ERRORS — Изменения не приняты.HAS_CARD_CAN_UPDATE_PROCESSING — Изменения на проверке.NO_CARD_NEED_CONTENT — Создайте карточку.NO_CARD_MARKET_WILL_CREATE — Создаст Маркет.NO_CARD_ERRORS — Не создана из-за ошибки.NO_CARD_PROCESSING — Проверяем данные.NO_CARD_ADD_TO_CAMPAIGN — Разместите товар в магазине.
Что обозначает каждый из статусов
Список товаров с информацией о состоянии карточек.
offerCards
paging (optional)
Состояние уцененного товара.
type (optional)
quality (optional)
reason (optional)
String Описание товара. Подробно опишите дефекты, насколько они заметны и где их искать.
Внешний вид товара:
PERFECT — идеальный.EXCELLENT — отличный.GOOD — хороший.NOT_SPECIFIED — не выбран.
Тип уценки:
PREOWNED — бывший в употреблении товар, раньше принадлежал другому человеку.SHOWCASESAMPLE — витринный образец.REFURBISHED — повторная продажа товара.REDUCTION — товар с дефектами.RENOVATED — восстановленный товар.NOT_SPECIFIED — не выбран.
REFURBISHED — специальное значение для одежды, обуви и аксессуаров. Используется только для уцененных товаров из этой категории. Другие значения для одежды, обуви и аксессуаров не используются.
Товар с указанными характеристиками.
offerId
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
categoryId
Integer Идентификатор категории на Маркете. Чтобы узнать идентификатор категории, к которой относится товар, воспользуйтесь запросом
POST categories/tree. format: int32
parameterValues
array[ParameterValueDTO] Список характеристик с их значениями.
С parameterValues обязательно передавайте marketCategoryId — идентификатор категории на Маркете, к которой относятся указанные характеристики товара.
При изменении характеристик передавайте только те, значение которых нужно обновить.
Чтобы удалить значение заданной характеристики, передайте ее parameterId с пустым value.
Максимальное количество характеристик — 300.
Текст ошибки.
type
parameterId (optional)
Long Идентификатор характеристики, с которой связана ошибка. format: int64
message
Типы ошибок:
OFFER_NOT_FOUND — такого товара нет в каталоге.UNKNOWN_CATEGORY — указана неизвестная категория.CATEGORY_MISMATCH — указана категория, которая не совпадает с категорией товара.UNKNOWN_PARAMETER — передана характеристика, которой нет среди характеристик категории.UNEXPECTED_BOOLEAN_VALUE — вместо boolean-значения передано что-то другое.NUMBER_FORMAT — передана строка, не обозначающая число, вместо числа.VALUE_BLANK — передано пустое значение.INVALID_UNIT_ID — передана единица измерения, недопустимая для характеристики.INVALID_GROUP_ID_LENGTH — в названии превышено допустимое значение символов — 255.INVALID_GROUP_ID_CHARACTERS — переданы недопустимые символы.
Предложение.
price (optional)
BigDecimal Цена предложения.
До версии 2.0 партнерского API у параметра был тип String.
feedId (optional)
Long Идентификатор прайс-листа, содержащего предложение.
Параметр доступен начиная с версии 2.0 партнерского API.
format: int64
id (optional)
String Идентификатор предложения из прайс-листа.
Параметр выводится, если в прайс-листе задан уникальный идентификатор. Если в прайс-листе содержится несколько предложений с одинаковыми идентификаторами, параметр id указывается только для первого из них, для остальных параметры id и feedId не выводятся.
Параметр доступен начиная с версии 2.0 партнерского API.
shopCategoryId (optional)
String Идентификатор категории предложения, указанный магазином в прайс-листе.
Параметр выводится только для предложений, у которых указана категория в прайс-листе.
Параметр доступен начиная с версии 2.0 партнерского API.
marketCategoryId (optional)
Integer Идентификатор категории предложения в дереве категорий Маркета.
Параметр доступен начиная с версии 2.0 партнерского API. format: int32
preDiscountPrice (optional)
discount (optional)
Integer Скидка на предложение в процентах. format: int32
cutPrice (optional)
Boolean Является ли предложение уцененным:
Параметр доступен начиная с версии 2.58 партнерского API.
url (optional)
String URL-адрес предложения на сайте магазина.
modelId
Long Идентификатор модели Маркета, с которой соотнесено предложение.
Если предложение не соотнесено ни с какой карточкой модели, то параметр modelid содержит значение 0.
{% note info %}
Идентификатор модели присутствует в URL карточки модели в виде значения параметра product. Например: https://market.yandex.ru/product/13584121.
{% endnote %}
format: int64
name (optional)
String Наименование предложения.
currency (optional)
bid (optional)
BigDecimal {% note warning "" %}
Этот параметр устарел. Не используйте его.
{% endnote %}
Ставка на клик.
cbid (optional)
BigDecimal {% note warning "" %}
Этот параметр устарел. Не используйте его.
{% endnote %}
Ставка на клик.
fee (optional)
BigDecimal {% note warning "" %}
Этот параметр устарел. Не используйте его.
{% endnote %}
Процент комиссии на товар при продаже по CPA.
blocked (optional)
Boolean Признак блокировки предложения.
Возможные значения:
false — предложение активно, параметр не выводится.true — предложение заблокировано.
Параметр выводится, если предложение заблокировано и не попадает в выдачу Маркета. Это может произойти из-за отключения магазина.
Сообщение об ошибке, связанной с размещением товара.
message (optional)
comment (optional)
Информация о состоянии цены на товар.
offerId (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
price (optional)
cofinancePrice (optional)
competitiveness (optional)
shows (optional)
Long Количество показов карточки товара за последние 7 дней. format: int64
Инструкция по использованию товара.
url
title (optional)
String Название инструкции, которое будет отображаться на карточке товара.
Информация о текущей карточке товара на Маркете.
marketSku (optional)
Long SKU на Маркете. format: int64
modelId (optional)
Long Идентификатор модели для текущей карточки товара на Маркете.
Например, две лопатки разных цветов имеют разные SKU на Маркете (параметр marketSku), но одинаковый идентификатор модели товара.
format: int64
categoryId (optional)
Long Идентификатор категории для текущей карточки товара на Маркете. format: int64
Информация о товарах в каталоге.
paging (optional)
offerMappingEntries
Список товаров.
mapping (optional)
awaitingModerationMapping (optional)
rejectedMapping (optional)
offer (optional)
Текст ошибки.
type
parameterId (optional)
Long Идентификатор характеристики, с которой связана ошибка. format: int64
message
Типы ошибок:
UNKNOWN_CATEGORY — указана неизвестная категория.CATEGORY_MISMATCH — указана категория, которая не совпадает с категорией товара.EMPTY_MARKET_CATEGORY — не указана категория Маркета при передаче характеристик категории.UNKNOWN_PARAMETER — передана характеристика, которой нет среди характеристик категории.UNEXPECTED_BOOLEAN_VALUE — вместо boolean-значения передано что-то другое.NUMBER_FORMAT — передана строка, не обозначающая число, вместо числа.VALUE_BLANK — передано пустое значение.INVALID_UNIT_ID — передана единица измерения, недопустимая для характеристики.INVALID_GROUP_ID_LENGTH — в названии превышено допустимое значение символов — 255.INVALID_GROUP_ID_CHARACTERS — переданы недопустимые символы.INVALID_PICKER_URL — передана ссылка на изображение для миниатюры, которой нет в переданных ссылках на изображение товара.
Информация о карточке товара.
mapping (optional)
awaitingModerationMapping (optional)
rejectedMapping (optional)
Список рекомендованных карточек товара.
Параметры товара.
Если у товара несколько значений одного параметра, передайте их с одним и тем же name, но разными value.
{% cut "Пример" %}
"params": [
{
"name": "Цвет",
"value": "Зеленый"
},
{
"name": "Цвет",
"value": "Желтый"
}
]
{% endcut %}
Информация об установленной цене.
offerId (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
price (optional)
updatedAt (optional)
Date Дата и время последнего обновления цены. format: date-time
Товар с информацией о новой цене на него.
offerId (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
price (optional)
Список цен на товары.
offers
paging (optional)
total (optional)
Integer Количество всех цен магазина, измененных через API. format: int32
Информация об установленной цене на товар.
id (optional)
String Идентификатор предложения из прайс-листа.
price (optional)
marketSku (optional)
Long SKU на Маркете. format: int64
updatedAt (optional)
Date Дата и время последнего обновления цены на товар. format: date-time
Причины, по которым товар не прошел модерацию.
type (optional)
payload (optional)
String Дополнительная информация о причине отклонения товара.
Тип причины, по которой товар не прошел модерацию:
ASSORTMENT — товар производится в разных вариантах. Каждый из них нужно описать как отдельный товар (входной параметр offer-mapping-entry запроса POST campaigns/{campaignId}/offer-mapping-entries/updates или строка в каталоге, если вы загружаете товары через кабинет продавца на Маркете).CANCELLED — товар отозван с модерации по вашей инициативе.CONFLICTING_INFORMATION (ранее ошибочно CONFLICTING) — вы предоставили противоречивую информацию о товаре. Параметры, которые нужно исправить, указаны в параметре payload.DEPARTMENT_FROZEN — правила размещения товаров в данной категории перерабатываются, поэтому товар пока не может пройти модерацию.INCORRECT_INFORMATION — информация о товаре, которую вы предоставили, противоречит описанию от производителя. Параметры, которые нужно исправить, указаны в параметре payload.LEGAL_CONFLICT — товар не прошел модерацию по юридическим причинам. Например, он официально не продается в России или у вас нет разрешения на его продажу.NEED_CLASSIFICATION_INFORMATION — информации о товаре, которую вы предоставили, не хватает, чтобы отнести его к категории. Проверьте, что правильно указали название, категорию, производителя и страны производства товара, а также URL изображений или страниц с описанием, по которым можно идентифицировать товар.NEED_INFORMATION — товар раньше не продавался в России и пока не размещается на Маркете. Для него можно создать карточку. Подробнее см. в разделе Работа с карточкой товара Справки Маркета для продавцов.NEED_PICTURES — для идентификации товара нужны его изображения. Отправьте URL изображений товара в запросе POST campaigns/{campaignId}/offer-mapping-entries/updates или загрузите обновленный каталог через кабинет продавца на Маркете.NEED_VENDOR — неверно указан производитель товара.NO_CATEGORY, NO_KNOWLEDGE — товары из указанной категории пока не размещаются на Маркете. Если категория появится, товар будет снова отправлен на модерацию.NO_PARAMETERS_IN_SHOP_TITLE — товар производится в разных вариантах, и из указанного названия непонятно, о каком идет речь. Параметры, которые нужно добавить в название товара, указаны в параметре payload.NO_SIZE_MEASURE — для этого товара нужна размерная сетка. Отправьте ее в службу поддержки или вашему менеджеру. Требования к размерной сетке указаны в параметре payload.UNKNOWN — товар не прошел модерацию по другой причине. Обратитесь в службу поддержки или к вашему менеджеру.
Информация о статусе публикации товара на Маркете.
status (optional)
notes (optional)
Статус публикации товара:
READY — товар прошел модерацию. Чтобы разместить его на Маркете, установите для него цену.IN_WORK — товар проходит модерацию. Это занимает несколько дней.NEED_CONTENT — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно (через API или кабинет продавца на Маркете) или создать ее, если товар еще не продается на Маркете.NEED_INFO — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара. Информация о причинах отклонения возвращается в параметре notes.REJECTED — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары.SUSPENDED — товар не прошел модерацию, так как Маркет пока не размещает подобные товары.
Информация о состоянии цен и рекомендации.
offer (optional)
recommendation (optional)
Рекомендации, касающиеся цены на товар.
offerId (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
recommendedCofinancePrice (optional)
competitivenessThresholds (optional)
Список товаров с рекомендациями.
paging (optional)
offerRecommendations
Информация о том, по каким моделям можно продавать товар, а по каким нельзя.
Информация о доступности или недоступности.
FINE — доступно.REJECT — недоступно.
Особый тип товара:
MEDICINE — лекарства.BOOK — бумажные и электронные книги.AUDIOBOOK — аудиокниги.ARTIST_TITLE — музыкальная и видеопродукция.ON_DEMAND — товары на заказ.
{% note info "Если ваш товар — книга" %}
Укажите год издания в характеристиках товара. Подробнее о параметре
{% endnote %}
Габариты упаковки и вес товара.
Если товар занимает несколько коробок, перед измерением размеров сложите их компактно.
length
width
height
weight
BigDecimal Вес товара в кг с учетом упаковки (брутто).
Найденные предложения магазина.
Значение ограничивающей характеристики и список допустимых значений ограничиваемой характеристики.
limitingOptionValueId
Long Идентификатор значения ограничивающей характеристики. format: int64
optionValueIds
array[Long] Идентификаторы допустимых значений ограничиваемой характеристики. format: int64
Информация о товаре в коробке.
id
fullCount (optional)
Integer Количество единиц товара в коробке.
Используйте это поле, если в коробке поедут целые товары, не разделенные на части. Не используйте это поле одновременно с partialCount.
format: int32
partialCount (optional)
instances (optional)
Информация о части товара в коробке.
current
Integer Номер части, начиная с 1. format: int32
total
Integer На сколько всего частей разделен товар. format: int32
Распределение товаров по коробкам.
Информация о покупателе.
inn (optional)
kpp (optional)
organizationName (optional)
String Наименование юридического лица.
organizationJurAddress (optional)
Информация о документах.
upd (optional)
ukd (optional)
torgTwelve (optional)
sf (optional)
ksf (optional)
Информация о покупателе с базовыми полями.
id (optional)
String Идентификатор покупателя.
lastName (optional)
firstName (optional)
middleName (optional)
type (optional)
Информация о покупателе.
Параметры id, lastName, firstName и middleName возвращаются, только если вы работаете по модели DBS.
id (optional)
String Идентификатор покупателя.
lastName (optional)
firstName (optional)
middleName (optional)
type (optional)
Информация о покупателе и его номере телефона.
id (optional)
String Идентификатор покупателя.
lastName (optional)
firstName (optional)
middleName (optional)
type (optional)
phone (optional)
Варианты причин, по которым заказ не может быть отменен.
ORDER_DELIVERED — заказ уже доставлен.ORDER_IN_DELIVERY — заказ уже у курьера.
Информация о курьере.
fullName (optional)
phone (optional)
String Номер телефона курьера.
phoneExtension (optional)
String Добавочный номер телефона.
vehicleNumber (optional)
String Номер транспортного средства.
vehicleDescription (optional)
String Описание машины. Например, модель и цвет.
Заказ.
id (optional)
Long Идентификатор заказа. format: int64
status (optional)
substatus (optional)
creationDate (optional)
String format: date-dd-MM-yyyy-HH-mm-ss
updatedAt (optional)
String format: date-dd-MM-yyyy-HH-mm-ss
currency (optional)
itemsTotal (optional)
deliveryTotal (optional)
buyerItemsTotal (optional)
BigDecimal {% note warning "" %}
Этот параметр устарел.
{% endnote %}
Стоимость всех товаров в заказе в валюте покупателя после применения скидок и без учета стоимости доставки.
format: decimal
buyerTotal (optional)
BigDecimal {% note warning "" %}
Этот параметр устарел.
{% endnote %}
Стоимость всех товаров в заказе в валюте покупателя после применения скидок и с учетом стоимости доставки.
format: decimal
buyerItemsTotalBeforeDiscount (optional)
BigDecimal Стоимость всех товаров в заказе в валюте покупателя без учета стоимости доставки и до применения скидок по:
- акциям;
- купонам;
- промокодам.
format: decimal
buyerTotalBeforeDiscount (optional)
BigDecimal {% note warning "" %}
Этот параметр устарел.
{% endnote %}
Стоимость всех товаров в заказе в валюте покупателя до применения скидок и с учетом стоимости доставки (buyerItemsTotalBeforeDiscount + стоимость доставки).
format: decimal
paymentType (optional)
paymentMethod (optional)
fake (optional)
items
subsidies (optional)
delivery (optional)
buyer (optional)
notes (optional)
taxSystem (optional)
cancelRequested (optional)
Boolean Только для модели DBS
Запрошена ли отмена.
expiryDate (optional)
String format: date-dd-MM-yyyy-HH-mm-ss
Адрес доставки.
Указывается, если type=DELIVERY, type=POST или type=PICKUP (адрес пункта выдачи).
country (optional)
String Страна.
Обязательный параметр.
postcode (optional)
String Почтовый индекс.
Указывается, если выбрана доставка почтой (delivery type=POST).
city (optional)
String Город или населенный пункт.
Обязательный параметр.
district (optional)
subway (optional)
street (optional)
String Улица.
Обязательный параметр.
house (optional)
String Дом или владение.
Обязательный параметр.
block (optional)
entrance (optional)
entryphone (optional)
floor (optional)
apartment (optional)
phone (optional)
String Телефон получателя заказа.
Обязательный параметр.
recipient (optional)
String Фамилия, имя и отчество получателя заказа.
Обязательный параметр.
gps (optional)
Информация о доставке.
id (optional)
String Идентификатор доставки, присвоенный магазином.
Указывается, только если магазин передал данный идентификатор в ответе на запрос методом POST cart.
type (optional)
serviceName (optional)
String Наименование службы доставки.
price (optional)
BigDecimal {% note warning "" %}
Этот параметр устарел. Стоимость доставки смотрите в параметре deliveryTotal.
{% endnote %}
Стоимость доставки в валюте заказа.
format: decimal
deliveryPartnerType (optional)
courier (optional)
dates (optional)
region (optional)
address (optional)
vat (optional)
deliveryServiceId (optional)
Long Идентификатор службы доставки. format: int64
liftType (optional)
liftPrice (optional)
BigDecimal Стоимость подъема на этаж. format: decimal
outletCode (optional)
String Идентификатор пункта самовывоза, присвоенный магазином.
outletStorageLimitDate (optional)
String Формат даты:
ДД-ММ-ГГГГ. format: date-dd-MM-yyyy
dispatchType (optional)
tracks (optional)
shipments (optional)
estimated (optional)
Boolean Приблизительная ли дата доставки.
eacType (optional)
eacCode (optional)
String Код подтверждения ЭАПП (для типа
MERCHANT_TO_COURIER).
Информация о новой дате доставки заказа.
toDate
date Новая дата доставки заказа.
Формат даты: ГГГГ-ММ-ДД.
format: date
Причина переноса доставки заказа. Возможные причины изменения даты:
USER_MOVED_DELIVERY_DATES — покупатель попросил изменить дату или вы договорились привезти ему заказ раньше изначальной даты. Кроме этого указывается для подтверждения даты доставки товаров на заказ с долгой (31-60 дней) доставкой.PARTNER_MOVED_DELIVERY_DATES — магазин не может доставить заказ в срок.
Диапазон дат доставки.
fromDate (optional)
String Формат даты:
ДД-ММ-ГГГГ. format: date-dd-MM-yyyy
toDate (optional)
String Формат даты:
ДД-ММ-ГГГГ. format: date-dd-MM-yyyy
fromTime (optional)
String Начало интервала времени доставки.
Передается только совместно с параметром type=DELIVERY.
Формат времени: 24-часовой, ЧЧ:ММ. В качестве минут всегда должно быть указано 00 (исключение — 23:59).
Минимальное значение: 00:00.
format: time
toTime (optional)
String Конец интервала времени доставки.
Передается только совместно с параметром type=DELIVERY.
Формат времени: 24-часовой, ЧЧ:ММ. В качестве минут всегда должно быть указано 00 (исключение — 23:59).
Максимальное значение: 23:59.
format: time
realDeliveryDate (optional)
String Формат даты:
ДД-ММ-ГГГГ. format: date-dd-MM-yyyy
Способ отгрузки:
-
BUYER — доставка покупателю.
-
MARKET_PARTNER_OUTLET — доставка в пункт выдачи партнера.
-
MARKET_BRANDED_OUTLET — доставка в пункт выдачи заказов Маркета.
-
SHOP_OUTLET — доставка в пункт выдачи заказов магазина.
-
DROPOFF — доставка в пункт выдачи, который принимает заказы от продавцов и передает их курьерам.
-
UNKNOWN — неизвестный тип.
Тип кода подтверждения ЭАПП:
-
MERCHANT_TO_COURIER — продавец передает код курьеру.
-
COURIER_TO_MERCHANT — курьер передает код продавцу.
-
CHECKING_BY_MERCHANT — продавец проверяет код на своей стороне.
Тип сотрудничества со службой доставки в рамках конкретного заказа:
-
SHOP — магазин работает со службой доставки напрямую или доставляет заказы самостоятельно.
-
YANDEX_MARKET — магазин работает со службой доставки через Маркет.
-
UNKNOWN — неизвестный тип.
Способ доставки заказа:
-
DELIVERY — курьерская доставка.
-
PICKUP — самовывоз.
-
POST — почта.
-
DIGITAL — для цифровых товаров.
-
UNKNOWN — неизвестный тип.
Ключ цифрового товара.
id
code
slip
String Инструкция по активации.
activate_till
date Дата, до которой нужно активировать ключ. Если ключ действует бессрочно, укажите любую дату в отдаленном будущем.
Формат даты: ГГГГ-ММ-ДД.
format: date
Статус документа:
READY — готов.NOT_READY — не готов.
Список товаров в заказе.
id (optional)
Long Идентификатор товара в заказе.
Позволяет идентифицировать товар в рамках данного заказа.
format: int64
offerId (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
offerName (optional)
price (optional)
BigDecimal Цена на товар в валюте заказа без учета вознаграждения партнеру за скидки по промокодам, купонам и акциям (параметр
subsidies). format: decimal
buyerPrice (optional)
BigDecimal Цена на товар в валюте покупателя. В цене уже учтены скидки по:
- акциям;
- купонам;
- промокодам.
format: decimal
buyerPriceBeforeDiscount (optional)
BigDecimal Стоимость товара в валюте покупателя до применения скидок по:
- акциям;
- купонам;
- промокодам.
format: decimal
priceBeforeDiscount (optional)
BigDecimal {% note warning "" %}
Этот параметр устарел.
{% endnote %}
Стоимость товара в валюте магазина до применения скидок.
format: decimal
count (optional)
vat (optional)
shopSku (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
subsidy (optional)
BigDecimal {% note warning "" %}
Этот параметр устарел. Вместо него используйте subsidies.
{% endnote %}
Общее вознаграждение партнеру за DBS-доставку и все скидки на товар:
- по промокодам;
- по купонам;
- по баллам Плюса;
- по акциям.
Передается в валюте заказа.
format: decimal
partnerWarehouseId (optional)
String {% note warning "" %}
Этот параметр устарел. Не используйте его.
{% endnote %}
Идентификатор склада в системе партнера, на который сформирован заказ.
promos (optional)
instances (optional)
details (optional)
subsidies (optional)
requiredInstanceTypes (optional)
Детали по товару в заказе.
itemCount (optional)
Long Количество единиц товара. format: int64
itemStatus (optional)
updateDate (optional)
String Формат даты:
ДД-ММ-ГГГГ. format: date-dd-MM-yyyy
Переданные вами для данной позиции коды маркировки или УИНы. Коды «Честного знака» возвращаются в двух вариантах — с криптохвостом и без.
cis (optional)
cisFull (optional)
uin (optional)
String УИН ювелирного изделия (16-значный код)
Производитель получает УИН, когда регистрирует изделие в системе контроля за оборотом драгоценных металлов и камней — ГИИС ДМДК.
rnpt (optional)
String Регистрационный номер партии товара.
Представляет собой строку из четырех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ/ХХХ.
Первая часть — код таможни, которая зарегистрировала декларацию на партию товара. Далее — дата, номер декларации и номер маркированного товара в декларации.
gtd (optional)
String Грузовая таможенная декларация.
Представляет собой строку из трех чисел, разделенных косой чертой: ХХХХХХХХ/ХХХХХХ/ХХХХХХХ.
Первая часть — код таможни, которая зарегистрировала декларацию на ввезенные товары. Далее — дата и номер декларации.
Позиция в корзине, требующая маркировки.
Вид маркировки товара:
-
CIS — КИЗ, идентификатор единицы товара в системе «Честный ЗНАК».
-
UIN — УИН, уникальный идентификационный номер.
-
RNPT — РНПТ, регистрационный номер партии товара.
-
GTD — номер ГТД, грузовой таможенной декларации.
Список товаров в заказе.
Если магазин не передал информацию о товаре во входных данных, он будет удален из заказа.
Обязательный параметр.
id
count
Integer Новое количество товара. format: int32
instances (optional)
Информация о вознаграждениях партнеру за скидки на товар по промокодам, купонам и акциям.
type
discount (optional)
BigDecimal Размер пользовательской скидки в валюте покупателя. format: decimal
subsidy (optional)
BigDecimal Вознаграждение партнеру от Маркета за товар, проданный в рамках акции.
Передается в валюте заказа.
format: decimal
shopPromoId (optional)
String Идентификатор акции поставщика.
marketPromoId (optional)
String Идентификатор акции в рамках соглашения на оказание услуг по продвижению сервиса между Маркетом и партнером.
Параметр передается, только если параметр type=MARKET_DEAL.
Возвращенный или невыкупленный товар:
Общее вознаграждение партнеру за все скидки на товар:
- по промокодам, купонам и акциям;
- по баллам Плюса.
Передается в валюте заказа.
type (optional)
amount (optional)
Тип субсидии:
-
YANDEX_CASHBACK — скидка по подписке Яндекс Плюс.
-
SUBSIDY — скидка Маркета (по акциям, промокодам, купонам и т. д.).
Причина обновления состава заказа.
Краткие сведения о промаркированных товарах. Параметр возвращается, если ответ OK.
Данные для печати ярлыка.
orderId
Long Идентификатор заказа. format: int64
placesNumber
Integer Количество коробок в заказе. format: int32
url
parcelBoxLabels
Тип подъема заказа на этаж:
-
NOT_NEEDED — не требуется.
-
MANUAL — ручной.
-
ELEVATOR — лифт.
-
CARGO_ELEVATOR — грузовой лифт.
-
FREE — любой из перечисленных выше, если включена опция бесплатного подъема.
-
UNKNOWN — неизвестный тип.
Информация о грузоместе.
id (optional)
Long Идентификатор грузоместа. format: int64
fulfilmentId (optional)
String Идентификатор грузового места в информационной системе магазина.
Способ оплаты заказа:
-
Значения, если выбрана оплата при оформлении заказа ("paymentType": "PREPAID"):
-
YANDEX — банковской картой.
-
APPLE_PAY — Apple Pay.
-
GOOGLE_PAY — Google Pay.
-
CREDIT — в кредит.
-
TINKOFF_CREDIT — в кредит в Тинькофф Банке.
-
TINKOFF_INSTALLMENTS — рассрочка в Тинькофф Банке.
-
EXTERNAL_CERTIFICATE — подарочным сертификатом (например, из приложения «Сбербанк Онлайн»).
-
SBP — через систему быстрых платежей.
-
B2B_ACCOUNT_PREPAYMENT — заказ оплачивает организация.
-
Значения, если выбрана оплата при получении заказа ("paymentType": "POSTPAID"):
-
CARD_ON_DELIVERY — банковской картой.
-
BOUND_CARD_ON_DELIVERY — привязанной картой при получении.
-
CASH_ON_DELIVERY — наличными.
-
B2B_ACCOUNT_POSTPAYMENT — заказ оплачивает организация после доставки.
-
UNKNOWN — неизвестный тип.
Значение по умолчанию: CASH_ON_DELIVERY.
Тип оплаты заказа:
-
PREPAID — оплата при оформлении заказа.
-
POSTPAID — оплата при получении заказа.
-
UNKNOWN — неизвестный тип.
Если параметр отсутствует, заказ будет оплачен при получении.
Тип скидки:
-
DIRECT_DISCOUNT — прямая скидка, которую устанавливает продавец или Маркет.
-
BLUE_SET — комплекты.
-
BLUE_FLASH — флеш-акция.
-
MARKET_COUPON — скидка по промокоду Маркета.
-
MARKET_PROMOCODE — скидка по промокоду магазина.
-
MARKET_BLUE — скидка на Маркете.
-
YANDEX_PLUS — бесплатная доставка с подпиской Яндекс Плюс.
-
YANDEX_EMPLOYEE — бесплатная доставка по определенным адресам.
-
LIMITED_FREE_DELIVERY_PROMO — бесплатная доставка по ограниченному предложению.
-
FREE_DELIVERY_THRESHOLD — бесплатная доставка при достижении определенной суммы заказа.
-
MULTICART_DISCOUNT — скидка за то, что оформлена мультикорзина.
-
FREE_DELIVERY_FOR_LDI — бесплатная доставка за то, что один из товаров крупногабаритный.
-
FREE_DELIVERY_FOR_LSC — бесплатная доставка за то, что одна из корзин в мультикорзине крупногабаритная.
-
FREE_PICKUP — бесплатная доставка в пункт выдачи заказов.
-
CHEAPEST_AS_GIFT — самый дешевый товар в подарок.
-
CASHBACK — кешбэк.
-
SUPPLIER_MULTICART_DISCOUNT — скидка за доставку.
-
SPREAD_DISCOUNT_COUNT — скидка за количество одинаковых товаров.
-
SPREAD_DISCOUNT_RECEIPT — скидка от суммы чека.
-
ANNOUNCEMENT_PROMO — информационная акция, скидка не применяется к товарам.
-
DISCOUNT_BY_PAYMENT_TYPE — прямая скидка при оплате картой Плюса.
-
PERCENT_DISCOUNT — прямая скидка в процентах.
-
DCO_EXTRA_DISCOUNT — дополнительная скидка, необходимая для расчета субсидии от Маркета.
-
EMPTY_PROMO — скрытые промокоды.
-
BLOCKING_PROMO — блокирующее промо.
-
UNKNOWN — неизвестный тип.
Устаревшие типы:
-
GENERIC_BUNDLE.
-
MARKET_DEAL.
-
MARKET_PRIME.
-
MARKET_COIN.
-
BERU_PLUS.
-
PRICE_DROP_AS_YOU_SHOP.
-
SECRET_SALE.
Список посылок.
В параметре может указываться несколько посылок.
id (optional)
Long Идентификатор посылки, присвоенный Маркетом. format: int64
shipmentDate (optional)
String Формат даты:
ДД-ММ-ГГГГ. format: date-dd-MM-yyyy
shipmentTime (optional)
String Только для модели Экспресс
Время, к которому магазин должен упаковать заказ и перевести его в статус READY_TO_SHIP. После смены статуса за заказом приедет курьер.
Поле может появиться не сразу. Запрашивайте информацию о заказе в течении 5–10 минут, пока оно не вернется.
Формат времени: 24-часовой, ЧЧ:ММ.
Если заказ сделан организацией, параметр не возвращается до согласования даты доставки.
tracks (optional)
boxes (optional)
Информация по заказу.
id
Long Идентификатор заказа. format: int64
status
substatus (optional)
Текущий статус заказа:
-
CANCELLED_BEFORE_PROCESSING — заказ отменен до начала его обработки.
-
CANCELLED_IN_DELIVERY — заказ отменен во время его доставки.
-
CANCELLED_IN_PROCESSING — заказ отменен во время его обработки.
-
DELIVERY — заказ передан службе доставки.
-
DELIVERED — заказ доставлен.
-
PARTIALLY_DELIVERED — заказ частично доставлен.
-
PARTIALLY_RETURNED — заказ частично возвращен покупателем.
-
PENDING — заказ ожидает подтверждения.
-
PICKUP — заказ доставлен в пункт выдачи.
-
PROCESSING — заказ в обработке.
-
RESERVED — товар зарезервирован на складе.
-
RETURNED — заказ полностью возвращен покупателем.
-
UNKNOWN — неизвестный статус заказа.
-
UNPAID — заказ от юридического лица ожидает оплаты.
-
LOST — заказ утерян.
Заказ.
status
substatus (optional)
delivery (optional)
Диапазон дат доставки.
realDeliveryDate (optional)
date Только для модели DBS
Фактическая дата доставки.
Когда передавать параметр realDeliveryDate:
-
Не передавайте параметр, если:
- переводите заказ в любой статус, кроме
PICKUP или DELIVERED;
- меняете статус заказа на
PICKUP или DELIVERED в день доставки — будет указана дата выполнения запроса.
-
Передавайте дату доставки, если переводите заказ в статус PICKUP или DELIVERED не в день доставки. Нельзя указывать дату доставки в будущем.
{% note warning "Индекс качества" %}
Передача статуса после установленного срока снижает индекс качества. О сроках читайте в Справке Маркета для продавцов.
{% endnote %}
format: date
Статус заказа:
-
CANCELLED — отменен.
-
DELIVERED — получен покупателем.
-
DELIVERY — передан в службу доставки.
-
PICKUP — доставлен в пункт самовывоза.
-
PROCESSING — находится в обработке.
-
PENDING — ожидает обработки со стороны продавца.
-
UNPAID — оформлен, но еще не оплачен (если выбрана оплата при оформлении).
-
PLACING — оформляется, подготовка к резервированию.
-
RESERVED — зарезервирован, но недооформлен.
-
PARTIALLY_RETURNED — возвращен частично.
-
RETURNED — возвращен полностью.
-
UNKNOWN — неизвестный статус.
Также могут возвращаться другие значения. Обрабатывать их не требуется.
Общее вознаграждение партнеру за DBS-доставку и все скидки на товар:
- по промокодам, купонам и акциям;
- по баллам Плюса;
- по доставке (DBS).
Передается в валюте заказа.
type (optional)
amount (optional)
Тип субсидии:
-
YANDEX_CASHBACK — скидка по подписке Яндекс Плюс.
-
SUBSIDY — скидка Маркета (по акциям, промокодам, купонам и т. д.)
-
DELIVERY — скидка за доставку (DBS).
Этап обработки заказа (если он имеет статус PROCESSING) или причина отмены заказа (если он имеет статус CANCELLED).
-
Значения для заказа в статусе PROCESSING:
-
STARTED — заказ подтвержден, его можно начать обрабатывать.
-
READY_TO_SHIP — заказ собран и готов к отправке.
-
Значения для заказа в статусе CANCELLED:
-
PROCESSING_EXPIRED — значение более не используется.
-
REPLACING_ORDER — покупатель решил заменить товар другим по собственной инициативе.
-
RESERVATION_EXPIRED — покупатель не завершил оформление зарезервированного заказа в течение 10 минут.
-
SHOP_FAILED — магазин не может выполнить заказ.
-
USER_CHANGED_MIND — покупатель отменил заказ по личным причинам.
-
USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут.
-
USER_REFUSED_DELIVERY — покупателя не устроили условия доставки.
-
USER_REFUSED_PRODUCT — покупателю не подошел товар.
-
USER_REFUSED_QUALITY — покупателя не устроило качество товара.
-
USER_UNREACHABLE — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:
- не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
- перерыв между первым и третьим звонком не менее 90 минут;
- соединение не короче 5 секунд.
Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.
-
TECHNICAL_ERROR — техническая ошибка на стороне Маркета. Обратитесь в поддержку.
Также могут возвращаться другие значения. Обрабатывать их не требуется.
Система налогообложения (СНО) магазина на момент оформления заказа:
-
ECHN — единый сельскохозяйственный налог (ЕСХН).
-
ENVD — единый налог на вмененный доход (ЕНВД).
-
OSN — общая система налогообложения (ОСН).
-
PSN — патентная система налогообложения (ПСН).
-
USN — упрощенная система налогообложения (УСН).
-
USN_MINUS_COST — упрощенная система налогообложения, доходы, уменьшенные на величину расходов (УСН «Доходы минус расходы»).
-
NPD — налог на профессиональный доход (НПД).
-
UNKNOWN_VALUE — неизвестное значение.
Используется только совместно с параметром payment-method=YANDEX.
Информация о трек-номере посылки (DBS).
trackCode (optional)
deliveryServiceId (optional)
Long Идентификатор службы доставки. Информацию о службе доставки можно получить с помощью запроса
GET delivery/services. format: int64
Изменился ли статус заказа:
Ставка налога на добавленную стоимость (НДС) на товар:
-
NO_VAT — НДС не облагается, используется только для отдельных видов услуг.
-
VAT_0 — НДС 0%. Например, используется при продаже товаров, вывезенных в таможенной процедуре экспорта, или при оказании услуг по международной перевозке товаров.
-
VAT_10 — НДС 10%. Например, используется при реализации отдельных продовольственных и медицинских товаров.
-
VAT_10_110 — НДС 10/110. Расчетная ставка НДС 10%, применяется только при предоплате.
-
VAT_20 — НДС 20%. Основная ставка с 2019 года.
-
VAT_20_120 — НДС 20/120. Расчетная ставка НДС 20%, применяется только при предоплате.
-
VAT_18 — НДС 18%. Основная ставка до 2019 года.
-
VAT_18_118 — НДС 18/118. Ставка использовалась до 1 января 2019 года при предоплате.
-
UNKNOWN_VALUE — неизвестный тип.
Используется только совместно с параметром payment-method=YANDEX.
Годные/негодные ярлыки по заказам в отгрузке.
orderIdsWithLabels
set[Long] Идентификаторы заказов в отгрузке, для которых можно распечатать ярлыки. format: int64
orderIdsWithoutLabels
set[Long] Идентификаторы заказов в отгрузке, для которых нельзя распечатать ярлыки. format: int64
Информация о стоимости услуг.
type (optional)
actual (optional)
BigDecimal Сумма в рублях, которая была выставлена в момент создания заказа и которую нужно оплатить.
Точность — два знака после запятой.
Услуга:
FEE — размещение товара на Маркете.FULFILLMENT — складская обработка. Не возвращается с 1 января 2024 года.LOYALTY_PARTICIPATION_FEE — участие в программе лояльности и отзывы за баллы.AUCTION_PROMOTION — буст продаж с оплатой за продажи.INSTALLMENT — рассрочка. Не возвращается с 24 февраля 2022 года.DELIVERY_TO_CUSTOMER — доставка покупателю (FBY, FBS). Для DBS и Экспресс — если заказ возвращается через логистику Маркета.EXPRESS_DELIVERY_TO_CUSTOMER — экспресс-доставка покупателю (Экспресс).AGENCY — прием платежа покупателя.PAYMENT_TRANSFER — перевод платежа покупателя.RETURNED_ORDERS_STORAGE — хранение невыкупов и возвратов (FBS). Для DBS и Экспресс — если заказ возвращается через логистику Маркета.SORTING — обработка заказа (FBS).INTAKE_SORTING — организация забора заказов со склада продавца (FBS).RETURN_PROCESSING — обработка заказов на складе (FBS). Для DBS и Экспресс — если заказ возвращается через логистику Маркета.ILLIQUID_GOODS_SALE — вознаграждение за продажу невывезенных товаров.
Информация о регионе доставки.
id (optional)
Long Идентификатор региона доставки. format: int64
name (optional)
String Название региона доставки.
Информация об удалении товара из заказа.
itemStatus (optional)
itemCount (optional)
Long Количество товара со статусом, указанном в параметре
itemStatus. format: int64
updateDate (optional)
date Дата, когда товар получил статус, указанный в параметре itemStatus.
Формат даты: ГГГГ-ММ-ДД.
format: date
stockType (optional)
Список товаров в заказе после возможных изменений.
В ходе обработки заказа Маркет может удалить из него единицы товаров — при проблемах на складе или по инициативе пользователя.
-
Если из заказа удалены все единицы товара, его не будет в списке items — только в списке initialItems.
-
Если в заказе осталась хотя бы одна единица товара, он будет и в списке items (с уменьшенным количеством единиц count), и в списке initialItems (с первоначальным количеством единиц initialCount).
offerName (optional)
marketSku (optional)
Long SKU на Маркете. format: int64
shopSku (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
count (optional)
Integer Количество единиц товара с учетом удаленных единиц.
Если из заказа удалены все единицы товара, он попадет только в список initialItems.
format: int32
prices (optional)
warehouse (optional)
details (optional)
cisList (optional)
initialCount (optional)
Integer Первоначальное количество единиц товара. format: int32
bidFee (optional)
Integer Списанная ставка ближайшего конкурента.
Указывается в процентах от стоимости товара и умножается на 100. Например, ставка 5% обозначается как 500.
format: int32
cofinanceThreshold (optional)
BigDecimal Порог для скидок с Маркетом на момент оформления заказа. Что это такое?
Указан в рублях. Точность — два знака после запятой.
cofinanceValue (optional)
Статус товара:
REJECTED — товар был добавлен в созданный заказ, но не был оплачен.RETURNED — товар вернули.
Информация о заказе.
id (optional)
Long Идентификатор заказа. format: int64
creationDate (optional)
date Дата создания заказа.
Формат даты: ГГГГ-ММ-ДД.
format: date
statusUpdateDate (optional)
Date Дата и время, когда статус заказа был изменен в последний раз.
Формат даты и времени: ISO 8601. Например, 2017-11-21T00:00:00. Часовой пояс — UTC+03:00 (Москва).
format: date-time
status (optional)
partnerOrderId (optional)
String Идентификатор заказа в информационной системе магазина.
paymentType (optional)
fake (optional)
deliveryRegion (optional)
items
initialItems (optional)
payments
commissions
Тип оплаты заказа:
CREDIT — заказ оформлен в кредит.POSTPAID — заказ оплачен после того, как был получен.PREPAID — заказ оплачен до того, как был получен.
Информация о денежных переводах по заказу.
id (optional)
String Идентификатор денежного перевода.
date (optional)
date Дата денежного перевода.
Формат даты: ГГГГ-ММ-ДД.
format: date
type (optional)
source (optional)
total (optional)
BigDecimal Сумма денежного перевода.
Значение указывается в рублях независимо от способа денежного перевода.
Точность — два знака после запятой.
paymentOrder (optional)
Информация о платежном получении.
id (optional)
String Номер платежного поручения.
date (optional)
date Дата платежного поручения.
Формат даты: ГГГГ‑ММ‑ДД.
format: date
Способ денежного перевода:
BUYER — оплата или возврат деньгами.CASHBACK — оплата или возврат баллами Плюса.MARKETPLACE — оплата или возврат купонами.SPLIT — оплата картой по частям (Сплит).
Тип денежного перевода:
PAYMENT — оплата.REFUND — возврат.
Цена или скидки на товар.
type (optional)
costPerItem (optional)
BigDecimal Цена или скидка на единицу товара в заказе.
Указана в рублях.
Точность — два знака после запятой.
total (optional)
BigDecimal Суммарная цена или скидка на все единицы товара в заказе.
Указана в рублях.
Точность — два знака после запятой.
Тип скидки или цена на товар:
BUYER — цена на товар с учетом скидок, в том числе купонов.CASHBACK — баллы Плюса.MARKETPLACE — купоны.
Информация о складе, на котором хранится товар.
id (optional)
Long Идентификатор склада. format: int64
name (optional)
Адрес точки продаж.
regionId
Long Идентификатор региона.
Идентификатор можно получить c помощью запроса GET regions.
{% note alert %}
При создании и редактировании точек продаж можно указывать только регионы типов TOWN (город), CITY (крупный город) и REPUBLIC_AREA (район субъекта федерации). Тип региона указан в выходных параметрах type запросов GET regions и GET regions/{regionId}.
{% endnote %}
format: int64
street (optional)
number (optional)
building (optional)
estate (optional)
block (optional)
additional (optional)
String Дополнительная информация.
km (optional)
Integer Порядковый номер километра дороги, на котором располагается точка продаж, если отсутствует улица. format: int32
city (optional)
String {% note warning "" %}
Этот параметр устарел. Не используйте его. Город или населенный пункт возвращается в параметре regionId.
{% endnote %}
Информация о точке продаж.
name
type
coords (optional)
String Координаты точки продаж.
Формат: долгота, широта. Разделители: запятая и / или пробел. Например, 20.4522144, 54.7104264.
Если параметр не передан, координаты будут определены по значениям параметров, вложенных в address.
isMain (optional)
Boolean Признак основной точки продаж.
Возможные значения:
false — неосновная точка продаж.true — основная точка продаж.
shopOutletCode (optional)
String Идентификатор точки продаж, присвоенный магазином.
visibility (optional)
address
phones
array[String] Номера телефонов точки продаж. Передавайте в формате:
+7 (999) 999-99-99.
workingSchedule
deliveryRules (optional)
array[OutletDeliveryRuleDTO] Информация об условиях доставки для данной точки продаж.
Обязательный параметр, если параметр type=DEPOT или type=MIXED.
storagePeriod (optional)
Long Срок хранения заказа в собственном пункте выдачи заказов. Считается в днях. format: int64
Информация об условиях доставки для данной точки продаж.
minDeliveryDays (optional)
Integer Минимальный срок доставки товаров в точку продаж. Указан в рабочих днях.
Минимальное значение: 0 — доставка в день заказа.
Максимальное значение: 60.
Допустимые сроки доставки (разница между minDeliveryDays и maxDeliveryDays) зависят от региона.
Для доставки по своему региону разница не должна превышать двух дней. Например, если minDeliveryDays равно 1, то для maxDeliveryDays допускаются значения от 1 до 3.
Для доставки в другие регионы:
- Если
minDeliveryDays до 18 дней, разница не должна превышать четырех дней. Например, если minDeliveryDays равно 10, то для maxDeliveryDays допускаются значения от 10 до 14.
- Если
minDeliveryDays больше 18 дней, разница должна быть не больше чем в два раза. Например, если minDeliveryDays равно 21, то для maxDeliveryDays допускаются значения от 21 до 42.
Обязательный параметр, если type="DEPOT" или type="MIXED".
Взаимоисключающий с параметром unspecifiedDeliveryInterval.
format: int32
maxDeliveryDays (optional)
Integer Максимальный срок доставки товаров в точку продаж. Указан в рабочих днях.
Минимальное значение: 0 — доставка в день заказа.
Максимальное значение: 60.
Допустимые сроки доставки (разница между minDeliveryDays и maxDeliveryDays) зависят от региона.
Для доставки по своему региону разница не должна превышать двух дней. Например, если minDeliveryDays равно 1, то для maxDeliveryDays допускаются значения от 1 до 3.
Для доставки в другие регионы:
- Если
minDeliveryDays до 18 дней, разница не должна превышать четырех дней. Например, если minDeliveryDays равно 10, то для maxDeliveryDays допускаются значения от 10 до 14.
- Если
minDeliveryDays больше 18 дней, разница должна быть не больше чем в два раза. Например, если minDeliveryDays равно 21, то для maxDeliveryDays допускаются значения от 21 до 42.
Обязательный параметр, если type="DEPOT" или type="MIXED".
Взаимоисключающий с параметром unspecifiedDeliveryInterval.
format: int32
deliveryServiceId (optional)
Long Идентификатор службы доставки товаров в точку продаж.
Информацию о службе доставки можно получить с помощью запроса GET delivery/services.
format: int64
orderBefore (optional)
Integer Час, до которого покупателю нужно сделать заказ, чтобы он был доставлен в точку продаж в сроки от minDeliveryDays до maxDeliveryDays.
Если покупатель оформит заказ после указанного часа, он будет доставлен в сроки от minDeliveryDays + 1 рабочий день до maxDeliveryDays + 1 рабочий день.
Значение по умолчанию: 24.
format: int32
priceFreePickup (optional)
BigDecimal Цена на товар, начиная с которой действует бесплатный самовывоз товара из точки продаж.
unspecifiedDeliveryInterval (optional)
Boolean Признак доставки товаров в точку продаж на заказ.
Признак выставлен, если:
- точный срок доставки в точку продаж заранее неизвестен (например, если магазин собирает несколько заказов для отправки в точку или населенный пункт);
- все товары изготавливаются или поставляются на заказ.
Возможные значения:
true — товары доставляются в точку продаж на заказ.
Параметр указывается только со значением true.
Взаимоисключающий с параметрами minDeliveryDays и maxDeliveryDays.
Информация о лицензии.
id (optional)
Long Идентификатор лицензии.
Параметр указывается, только если нужно изменить информацию о существующей лицензии. Ее идентификатор можно узнать с помощью запроса GET campaigns/{campaignId}/outlets/licenses. При передаче информации о новой лицензии указывать идентификатор не нужно.
Идентификатор лицензии присваивается Маркетом. Не путайте его с номером, указанным на лицензии: он передается в параметре number.
format: int64
outletId (optional)
Long Идентификатор точки продаж, для которой действительна лицензия. format: int64
licenseType (optional)
number (optional)
dateOfIssue (optional)
Date Дата выдачи лицензии.
Формат даты: ISO 8601 со смещением относительно UTC. Нужно передать дату, указанную на лицензии, время 00:00:00 и часовой пояс, соответствующий региону точки продаж. Например, если лицензия для точки продаж в Москве выдана 13 ноября 2017 года, то параметр должен иметь значение 2017-11-13T00:00:00+03:00.
Обязательный параметр.
Не может быть позже даты окончания срока действия, указанной в параметре dateOfExpiry.
format: date-time
dateOfExpiry (optional)
Date Дата окончания действия лицензии.
Формат даты: ISO 8601 со смещением относительно UTC. Нужно передать дату, указанную на лицензии, время 00:00:00 и часовой пояс, соответствующий региону точки продаж. Например, если действие лицензии для точки продаж в Москве заканчивается 20 ноября 2022 года, то параметр должен иметь значение 2022-11-20T00:00:00+03:00.
Обязательный параметр.
Не может быть раньше даты выдачи, указанной в параметре dateOfIssue.
format: date-time
Ответ на запрос информации о лицензиях для точек продаж.
Результат выполнения запроса.
Выводится, если status="OK".
id (optional)
Long Идентификатор точки продаж, присвоенный Маркетом. format: int64
Статус точки продаж.
Возможные значения:
AT_MODERATION — проверяется.FAILED — не прошла проверку и отклонена модератором.MODERATED — проверена и одобрена.NONMODERATED — новая точка, нуждается в проверке.
Тип точки продаж.
Возможные значения:
DEPOT — пункт выдачи заказов.MIXED — смешанный тип точки продаж (торговый зал и пункт выдачи заказов).RETAIL — розничная точка продаж (торговый зал).
Состояние точки продаж.
Возможные значения:
HIDDEN — точка продаж выключена.VISIBLE — точка продаж включена.
Список режимов работы точки продаж.
workInHoliday (optional)
Boolean Признак, работает ли точка продаж в дни государственных праздников.
Возможные значения:
false — точка продаж не работает в дни государственных праздников.true — точка продаж работает в дни государственных праздников.
scheduleItems
Расписание работы точки продаж.
startDay
endDay
startTime
String Точка продаж работает c указанного часа.
Формат: ЧЧ:ММ.
endTime
String Точка продаж работает до указанного часа.
Формат: ЧЧ:ММ.
Размещение ярлыков на странице:
A7 — в PDF-файле будут страницы формата близкому к A7. На каждой странице размещается ярлык размером 75 × 120 мм (80,4 × 125,6 мм с учетом полей).A4 — в PDF-файле будут страницы формата A4. На каждой странице размещаются восемь ярлыков размером 70,6 × 99,1 мм без полей.
Возвраты.
paging (optional)
returns
Количество палет в отгрузке.
planned (optional)
Integer Количество палет, которое заявил продавец. format: int32
fact (optional)
Integer Количество палет, которое приняли в сортировочном центре. format: int32
Тип данных:
TEXT — текст.ENUM — список возможных значений.BOOLEAN — true или false.NUMERIC — число.
Ограничения на значения характеристик.
minValue (optional)
Double Минимальное число. format: double
maxValue (optional)
Double Максимальное число. format: double
maxLength (optional)
Integer Максимальная длина текста. format: int32
Значение характеристики.
Вы можете указывать несколько значений одной характеристики при условии, что:
Для этого в parameterValues передавайте каждое значение отдельно — несколько объектов с параметрами parameterId, valueId и value. Параметр parameterId должен быть одинаковым.
parameterId
Long Идентификатор характеристики. format: int64
unitId (optional)
Long Идентификатор единицы измерения. Если вы не передали параметр
unitId, используется единица измерения по умолчанию. format: int64
valueId (optional)
Long Идентификатор значения.
Обязательно указывайте идентификатор, если передаете значение из перечня допустимых значений, полученного от Маркета.
Только для характеристик типа ENUM.
format: int64
value (optional)
Значение характеристики.
id
Long Идентификатор значения. format: int64
value
description (optional)
Элемент отображает одно грузовое место. Вложенные поля больше не используются, передавайте элемент пустым в запросах и не обращайте внимание на содержимое в ответах.
id (optional)
Long {% note warning "" %}
Этот параметр устарел. Не используйте его.
{% endnote %}
format: int64
fulfilmentId (optional)
String {% note warning "" %}
Этот параметр устарел. Не используйте его.
{% endnote %}
Информация о ярлыке для коробки.
url
supplierName
String Юридическое название магазина.
deliveryServiceName
String Юридическое название службы доставки.
orderId
Long Идентификатор заказа в системе Маркета. format: int64
orderNum
String Идентификатор заказа в информационной системе магазина.
Совпадает с orderId, если Маркету неизвестен номер заказа в системе магазина.
recipientName
String Фамилия и инициалы получателя заказа.
boxId
Long Идентификатор коробки. format: int64
fulfilmentId
String Идентификатор коробки в информационной системе магазина.
Возвращается в формате: номер заказа на Маркете-номер коробки. Например, 7206821‑1, 7206821‑2 и т. д.
place
String Номер коробки в заказе. Возвращается в формате:
номер места/общее количество мест.
weight
String {% note warning "" %}
Этот параметр устарел. Не используйте его.
{% endnote %}
Общая масса всех товаров в заказе. Возвращается в формате: weight кг.
deliveryServiceId
deliveryAddress (optional)
shipmentDate (optional)
String Дата отгрузки в формате
dd.MM.yyyy.
Информация о грузовых местах в заказе.
boxes
array[ParcelBoxDTO] Список грузовых мест. Маркет определяет количество мест по длине этого списка.
Данные о складе отправления.
id (optional)
Long Идентификатор склада отправления. format: int64
name (optional)
String Наименование склада отправления.
address (optional)
String Адрес склада отправления.
Частота выплат:
DAILY — ежедневно.WEEKLY — раз в неделю.BIWEEKLY — раз в две недели.MONTHLY — раз в месяц.
Подробнее о графике выплат читайте в Справке Маркета для продавцов.
Адрес доставки.
country (optional)
city (optional)
street (optional)
house (optional)
postcode (optional)
Модель, по которой работает магазин:
FBS — FBS или Экспресс.FBY — FBY.DBS — DBS.
Максимальные значения цены, при которых она является привлекательной или умеренной.
optimalPrice (optional)
averagePrice (optional)
Привлекательность цены:
OPTIMAL — привлекательная.AVERAGE — умеренная.LOW — непривлекательная.
Цена с указанием скидки, валюты и времени последнего обновления.
value (optional)
discountBase (optional)
BigDecimal Цена на товар без скидки.
Число должно быть целым. Вы можете указать цену со скидкой от 5 до 99%.
Передавайте этот параметр при каждом обновлении цены, если предоставляете скидку на товар.
currencyId (optional)
vat (optional)
Integer Идентификатор ставки НДС, применяемой для товара:
2 — 10%.5 — 0%.6 — не облагается НДС.7 — 20%.
Если параметр не указан, используется ставка НДС, установленная в кабинете.
format: int32
Причина попадания товара в карантин.
Имя параметра причины скрытия товара по цене.
CURRENT_PRICE — цена, из-за которой товар попал в карантин.LAST_VALID_PRICE — последняя цена до попадания в карантин (только для карантина типа PRICE_CHANGE).MIN_PRICE — порог попадания в карантин (только для карантина типов LOW_PRICE и LOW_PRICE_PROMO).CURRENCY — валюта.
Типы карантина:
PRICE_CHANGE — новая цена слишком сильно отличается от прежней. В поле params будет новая цена CURRENT_PRICE и последняя цена до попадания в карантин LAST_VALID_PRICE.LOW_PRICE — установленная цена слишком сильно отличается от рыночной. В поле params будет установленная вами цена CURRENT_PRICE и порог попадания в карантин MIN_PRICE.LOW_PRICE_PROMO — цена после применения акций слишком сильно отличается от рыночной. В поле params будет цена после применения акций CURRENT_PRICE и порог попадания в карантин MIN_PRICE.
Рекомендованная цена.
campaignId
Long Идентификатор кампании. format: int64
price
Тип цены.
type (optional)
price (optional)
Товар с ценами для продвижения.
marketSku (optional)
Long SKU на Маркете. format: int64
offerId (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
priceSuggestion (optional)
Тип цены:
BUYBOX — самая низкая цена на товар, по которой он продается сейчас. Эта цена обновляется в режиме реального времени. Если вы установите цену ниже, начнет показываться ваше предложение. Если для этого значения в параметре price указана цена, которая совпадает с вашей, значит, ваш товар уже показывается на витрине. Если кроме вас этот товар продают другие продавцы по такой же цене, их предложения также будут отображаться вместе с вашими по очереди.DEFAULT_OFFER — рекомендованная Маркетом цена, которая привлекает покупателей. Рассчитывается только для популярных на сервисе товаров и обновляется раз в четыре часа.MIN_PRICE_MARKET — минимальная цена на Маркете. Самая низкая цена среди всех предложений товара на Маркете во всех регионах, включая те, которые не видны на витрине. Эта цена обновляется в режиме реального времени и обеспечивает большее количество показов на Маркете, чем самая низкая или рекомендованная цена.
Информация об автоматическом добавлении товара в акцию.
Причины, по которым товар не был добавлен автоматически в других магазинах, можно узнать в кабинете продавца на Маркете на странице акции.
Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.
campaignIds (optional)
array[Long] Магазины, в которых товар добавлен в акцию автоматически.
Возвращается, если статус товара в акции — PARTIALLY_AUTO.
format: int64
Параметры товара в акции с типом DIRECT_DISCOUNT или BLUE_FLASH.
price (optional)
Long Зачеркнутая цена — та, по которой товар продавался до акции.
Указывается в рублях.
Возвращается, только если товар участвует в акции.
format: int64
promoPrice (optional)
Long Цена по акции — та, по которой вы хотите продавать товар.
Указывается в рублях.
Возвращается, только если товар участвует в акции.
format: int64
maxPromoPrice
Long Максимально возможная цена для участия в акции.
Указывается в рублях.
Возвращается для всех товаров.
format: int64
Параметры товара в акции.
Возвращается параметр, который соответствует типу акции.
discountParams (optional)
promocodeParams (optional)
Фильтр для товаров, которые добавлены в акцию вручную:
-
MANUALLY_ADDED — товары, которые добавлены вручную.
-
NOT_MANUALLY_ADDED— товары, которые не участвуют в акции и те, которые добавлены автоматически.
Если не передать параметр statusType, вернутся все товары.
Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.
Статус товара в акции:
-
AUTO — добавлен автоматически во всех магазинах кабинета, в которых товар доступен для покупки.
-
PARTIALLY_AUTO — добавлен автоматически у части магазинов.
-
MANUAL — добавлен вручную.
-
NOT_PARTICIPATING — не участвует в акции.
Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.
Параметры товара в акции с типом MARKET_PROMOCODE.
maxPrice
Long Максимально возможная цена для участия в акции до применения промокода.
Указывается в рублях.
Возвращается для всех товаров.
format: int64
Предупреждение, которое появилось при добавлении товара:
-
DEEP_DISCOUNT_OFFER — большая разница с ценой в каталоге. Проверьте, нет ли ошибки.
-
CATALOG_PRICE_IS_LOWER_THAN_PROMO — базовая цена в кабинете ниже цены по акции. У товара в акции будет отображаться базовая цена.
-
SHOP_PRICES_ARE_LOWER_THAN_PROMO — цена в отдельном магазине ниже цены по акции. У товара в акции будет отображаться цена в магазине. Для остальных магазинов будет действовать цена по акции.
-
PROMOCODE_PRICE_MORE_THAN_MAX_FAIR_PRICE — в отдельном магазине цена с учетом промокода выше максимально возможной цены. Товар не будет участвовать в акции.
-
SHOP_OFFER_NOT_ELIGIBLE_FOR_PROMO — товар в отдельном магазине не подходит под условия акции.
Предупреждение, которое появилось при добавлении товара в акцию или изменении его цен.
code
campaignIds (optional)
array[Long] Идентификаторы магазинов в кабинете, для которых получены предупреждения.
Не возвращается, если предупреждения действуют для всех магазинов в кабинете.
format: int64
Какие акции вернутся:
-
PARTICIPATING_NOW — текущие и будущие акции продавца.
-
PARTICIPATED — завершенные акции продавца за последний год. Если за год их было меньше 15, в ответе придут 15 последних акций за все время.
Время проведения акции.
dateTimeFrom
Date Дата и время начала акции. format: date-time
dateTimeTo
Date Дата и время окончания акции. format: date-time
Запрос на передачу ключей цифровых товаров.
items
array[OrderDigitalItemDTO] Список проданных ключей.
Если в заказе есть несколько одинаковых товаров (например, несколько ключей к одной и той же подписке), передайте каждый в виде отдельного элемента массива. id у этих элементов должен быть один и тот же.
status (optional)
result (optional)
Информация о заказе, который повлиял на индекс качества.
orderId
Long Идентификатор заказа. format: int64
description
componentType
Составляющая индекса качества.
value
Double Значение составляющей в процентах. format: double
componentType
Составляющие индекса качества.
Для модели DBS:
DBS_CANCELLATION_RATE — доля отмененных товаров.DBS_LATE_DELIVERY_RATE — доля заказов, доставленных после плановой даты.
Для моделей FBS и Экспресс:
FBS_CANCELLATION_RATE — доля отмененных товаров.FBS_LATE_SHIP_RATE — доля не вовремя отгруженных заказов.
Для модели FBY:
FBY_LATE_DELIVERY_RATE — доля товаров, которые приехали на склад с опозданием.FBY_CANCELLATION_RATE — доля отмененных или недоставленных товаров.FBY_DELIVERY_DIFF_RATE — доля товаров, которые не прибыли вместе с поставкой или которые не приняли.FBY_LATE_EDITING_RATE — доля товаров, которые поздно убрали из заявки.
Информация об индексе качества.
rating
Long Значение индекса качества. format: int64
calculationDate
date Дата вычисления.
Формат даты: ГГГГ‑ММ‑ДД.
format: date
components
Информация о заказах, которые повлияли на индекс качества.
Настройка продажи квантами.
Чтобы сбросить установленные ранее значения, передайте пустой параметр quantum.
{% cut "Пример" %}
{
"offers": [
{
"offerId": "08e35dc1-89a2-11e3-8055-0015e9b8c48d",
"quantum": {}
}
]
}
{% endcut %}
minQuantity (optional)
Integer Минимальное количество единиц товара в заказе. Например, если указать 10, покупатель сможет добавить в корзину не меньше 10 единиц.
⚠️ Если количество товара на складе меньше заданного, ограничение не сработает и покупатель сможет его заказать.
format: int32
stepQuantity (optional)
Integer На сколько единиц покупатель сможет увеличить количество товара в корзине.
Например, если задать 5, покупатель сможет добавить к заказу только 5, 10, 15, ... единиц товара.
⚠️ Если количество товара на складе не дотягивает до кванта, ограничение не сработает и покупатель сможет заказать количество, не кратное кванту.
format: int32
Товар в карантине.
offerId (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
currentPrice (optional)
lastValidPrice (optional)
verdicts (optional)
Способ возврата товара покупателем:
Cтатус возврата денег:
-
STARTED_BY_USER — создан клиентом из личного кабинета.
-
REFUND_IN_PROGRESS — ждет решение о возврате денег.
-
REFUNDED — по возврату проведены все возвратные денежные транзакции.
-
FAILED — невозможно провести возврат покупателю.
-
WAITING_FOR_DECISION — ожидает решения.
-
DECISION_MADE — по возврату принято решение.
-
REFUNDED_WITH_BONUSES — возврат осуществлен баллами Плюса или промокодом.
-
REFUNDED_BY_SHOP — магазин сделал самостоятельно возврат денег.
-
COMPLETE_WITHOUT_REFUND — возврат денег не требуется.
-
CANCELLED — возврат отменен.
Регион доставки.
id (optional)
Long Идентификатор региона. format: int64
name
type
parent (optional)
children (optional)
Тип региона.
Возможные значения:
-
CITY_DISTRICT — район города.
-
CITY — крупный город.
-
CONTINENT — континент.
-
COUNTRY_DISTRICT — область.
-
COUNTRY — страна.
-
REGION — регион.
-
REPUBLIC_AREA — район субъекта федерации.
-
REPUBLIC — субъект федерации.
-
SUBWAY_STATION — станция метро.
-
VILLAGE — город.
-
OTHER — неизвестный регион.
Региональная информация.
currency (optional)
regionId (optional)
Long Идентификатор региона, для которого выводится информация о предложениях модели (доставляемых в этот регион).
Информацию о регионе по идентификатору можно получить с помощью запроса GET regions/{regionId}.
format: int64
Информация о товаре и ошибки, которые появились при его удалении.
offerId
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
reason
Описание ошибки:
OFFER_DOES_NOT_EXIST — в кабинете нет товара с таким SKU.
Описание отклоненного изменения.
offerId
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
reason
Причина отклонения изменения:
-
OFFER_DOES_NOT_EXIST — в кабинете нет товара с таким SKU.
-
OFFER_DUPLICATION — один и тот же товар передан несколько раз.
-
OFFER_NOT_ELIGIBLE_FOR_PROMO — товар не подходит под условия акции.
-
OFFER_PROMOS_MAX_BYTE_SIZE_EXCEEDED — товар не добавлен в акцию по техническим причинам.
-
DEADLINE_FOR_FOCUS_PROMOS_EXCEEDED — истек срок добавления товаров в акцию.
-
EMPTY_OLD_PRICE — не указана зачеркнутая цена.
-
EMPTY_PROMO_PRICE — не указана цена по акции.
-
MAX_PROMO_PRICE_EXCEEDED — цена по акции превышает максимально возможную цену для участия в акции.
-
PROMO_PRICE_BIGGER_THAN_MAX — цена по акции больше 95% от зачеркнутой цены.
-
PROMO_PRICE_SMALLER_THAN_MIN — цена по акции меньше 1% от зачеркнутой цены.
Формат отчета:
FILE — файл с электронной таблицей.CSV — ZIP-архив с CSV-файлами на каждый лист отчета.
Статус генерации и ссылка на готовый отчет.
status
subStatus (optional)
generationRequestedAt
Date Дата и время запроса на генерацию. format: date-time
generationFinishedAt (optional)
Date Дата и время завершения генерации. format: date-time
file (optional)
String Ссылка на готовый отчет.
estimatedGenerationTime (optional)
Long Ожидаемая продолжительность генерации в миллисекундах. format: int64
Статус генерации отчета:
PENDING — отчет ожидает генерации.PROCESSING — отчет генерируется.FAILED — во время генерации произошла ошибка.DONE — отчет готов.
Подстатус генерации отчета:
NO_DATA — для такого отчета нет данных.TOO_LARGE — отчет превысил допустимый размер — укажите меньший период времени или уточните условия запроса.RESOURCE_NOT_FOUND — для такого отчета не удалось найти часть сущностей.
Возврат заказа.
id (optional)
Long Идентификатор возврата. format: int64
orderId (optional)
Long Номер заказа. format: int64
creationDate (optional)
Date Дата создания возврата клиентом. format: date-time
updateDate (optional)
Date Дата обновления возврата. format: date-time
refundStatus (optional)
logisticPickupPoint (optional)
shipmentRecipientType (optional)
shipmentStatus (optional)
refundAmount (optional)
Long Сумма возврата. format: int64
items
returnType (optional)
fastReturn (optional)
Boolean Используется ли опция
Быстрый возврат денег за дешевый брак.
Решения по возвратам.
returnItemId (optional)
Long Идентификатор товара в возврате. format: int64
count (optional)
Integer Количество единиц товара. format: int32
comment (optional)
reasonType (optional)
subreasonType (optional)
decisionType (optional)
refundAmount (optional)
Long Сумма возврата. format: int64
partnerCompensation (optional)
Long Компенсация за обратную доставку. format: int64
images (optional)
Причины возврата:
-
BAD_QUALITY — бракованный товар (есть недостатки).
-
DO_NOT_FIT — товар не подошел.
-
WRONG_ITEM — привезли не тот товар.
-
DAMAGE_DELIVERY — товар поврежден при доставке.
-
LOYALTY_FAIL — невозможно установить виновного в браке/пересорте.
-
CONTENT_FAIL — ошибочное описание товара по вине Маркета.
-
UNKNOWN — причина не известна.
Детали причин возврата:
-
DO_NOT_FIT:
USER_DID_NOT_LIKE — товар не понравился.USER_CHANGED_MIND — передумал покупать.DELIVERED_TOO_LONG — длительный срок доставки, поэтому передумал.
-
BAD_QUALITY:
BAD_PACKAGE — упаковка товара была нарушена.DAMAGED — царапины, сколы.NOT_WORKING — не включается / не работает.INCOMPLETENESS — некомплект (не хватает детали в наборе, к товару).
-
WRONG_ITEM:
WRONG_ITEM — не тот товар.WRONG_COLOR — не соответствует по цвету.DID_NOT_MATCH_DESCRIPTION — не соответствует заявленным характеристикам/описанию.
Решение по возврату:
-
REFUND_MONEY — вернуть деньги покупателю.
-
REFUND_MONEY_INCLUDING_SHIPMENT — вернуть деньги за товар и пересылку.
-
REPAIR — отремонтировать товар.
-
REPLACE — заменить товар.
-
SEND_TO_EXAMINATION — взять товар на экспертизу.
-
DECLINE_REFUND — отказать в возврате.
-
OTHER_DECISION — другое решение.
Логистическая информация по возврату.
stockType (optional)
status (optional)
cis (optional)
imei (optional)
String Международный идентификатор мобильного оборудования.
Логистический статус конкретного товара.
Список товаров в возврате.
marketSku (optional)
Long SKU на Маркете. format: int64
shopSku
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
count
Long Количество единиц товара. format: int64
decisions (optional)
instances (optional)
tracks (optional)
Статус передачи возврата:
-
CREATED — возврат создан.
-
RECEIVED — принят у покупателя.
-
IN_TRANSIT — возврат в пути.
-
READY_FOR_PICKUP — возврат готов к выдаче магазину.
-
PICKED — возврат выдан магазину.
-
LOST — возврат утерян при транспортировке.
-
CANCELLED — возврат отменен.
-
FULFILMENT_RECEIVED — возврат принят на складе Маркета.
-
PREPARED_FOR_UTILIZATION — возврат передан в утилизацию.
-
UTILIZED — возврат утилизирован.
Тип заказа для фильтрации:
-
RETURN — возврат.
-
UNREDEEMED — невыкуп.
Если не указывать, в ответе будут и возвраты, и невыкупы.
Информация о страницах результатов.
nextPageToken (optional)
String Идентификатор следующей страницы результатов.
prevPageToken (optional)
String Идентификатор предыдущей страницы результатов.
models
currency (optional)
regionId (optional)
Long Идентификатор региона, для которого выводится информация о предложениях модели (доставляемых в этот регион).
Информацию о регионе по идентификатору можно получить с помощью запроса GET regions/{regionId}.
format: int64
pager (optional)
Запрос информации об отгрузках.
dateFrom
date Начальная дата для фильтрации по дате отгрузки (включительно).
Формат даты: ДД-ММ-ГГГГ.
format: date
dateTo
date Конечная дата для фильтрации по дате отгрузки (включительно).
Формат даты: ДД-ММ-ГГГГ.
format: date
statuses (optional)
orderIds (optional)
set[Long] Список идентификаторов заказов из отгрузок. format: int64
cancelledOrders (optional)
Boolean Возвращать ли отмененные заказы.
Значение по умолчанию — true. Если возвращать отмененные заказы не нужно, передайте значение false.
Ответ на запрос информации об отгрузках.
status (optional)
result (optional)
Информация об отгрузках.
shipments
paging (optional)
Модель размещения:
FBY — FBY.FBS — FBS.DBS — DBS.EXPRESS — Экспресс.
В какой чат нужно отправить сообщение и текст сообщения.
message
String Текст сообщения. Максимальная длина — 4096 символа.
Запрос на обновление изменение параметров прайс-листа.
boxes
allowRemove (optional)
Boolean Передайте
true, если вы собираетесь удалить часть товаров из заказа.
status (optional)
result (optional)
trackCode
deliveryServiceId
Long Идентификатор службы доставки. Информацию о службе доставки можно получить с помощью запроса
GET delivery/services. format: int64
boxes
array[ParcelBoxDTO] Список грузовых мест. Маркет определяет количество мест по длине этого списка.
status (optional)
result (optional)
Решения по позиции в возврате.
returnItemId
Long Идентификатор товара в возврате. format: int64
decisionType
comment (optional)
String Комментарий к решению. Укажите:
-
для REFUND_MONEY_INCLUDING_SHIPMENT— стоимость обратной пересылки;
-
для REPAIR — когда вы устраните недостатки товара;
-
для DECLINE_REFUND — причину отказа;
-
для OTHER_DECISION — какое решение вы предлагаете.
Запрос на передачу количества упаковок в отгрузке.
placesCount
Integer Количество упаковок в отгрузке. format: int32
Тип атрибуции:
CLICKS — по кликам.SHOWS — по показам.
О том, какие данные в отчете зависят и не зависят от типа атрибуции, читайте в Справке Маркета для продавцов.
Действия с отгрузкой:
CONFIRM — подтвердить отгрузку.DOWNLOAD_ACT — скачать акт приема-передачи отгрузки.DOWNLOAD_INBOUND_ACT — скачать список принятых заказов.DOWNLOAD_DISCREPANCY_ACT — скачать акт расхождений.CHANGE_PALLETS_COUNT — указать количество палет.
В ответе Маркет возвращает переданный вами список грузовых мест. Не обращайте на это поле внимания.
boxes
array[ParcelBoxDTO] Список грузовых мест. Маркет определил количество мест по длине этого списка.
Информация об отгрузке.
id (optional)
Long Идентификатор отгрузки. format: int64
planIntervalFrom (optional)
Date Начало планового интервала отгрузки. format: date-time
planIntervalTo (optional)
Date Конец планового интервала отгрузки. format: date-time
shipmentType (optional)
warehouse (optional)
warehouseTo (optional)
externalId (optional)
String Идентификатор отгрузки в вашей системе. Если вы еще не передавали идентификатор, вернется идентификатор из параметра
id.
deliveryService (optional)
palletsCount (optional)
orderIds
set[Long] Идентификаторы заказов в отгрузке. format: int64
draftCount (optional)
Integer Количество заказов, которое Маркет запланировал к отгрузке. format: int32
plannedCount (optional)
Integer Количество заказов, которое Маркет подтвердил к отгрузке. format: int32
factCount (optional)
Integer Количество заказов, принятых в сортировочном центре или пункте приема. format: int32
currentStatus (optional)
availableActions
Список с информацией об отгрузках.
id (optional)
Long Идентификатор отгрузки. format: int64
planIntervalFrom (optional)
Date Начало планового интервала отгрузки. format: date-time
planIntervalTo (optional)
Date Конец планового интервала отгрузки. format: date-time
shipmentType (optional)
warehouse (optional)
warehouseTo (optional)
externalId (optional)
String Идентификатор отгрузки в вашей системе. Если вы еще не передавали идентификатор, вернется идентификатор из параметра
id.
deliveryService (optional)
palletsCount (optional)
orderIds
set[Long] Идентификаторы заказов в отгрузке. format: int64
draftCount (optional)
Integer Количество заказов, которое Маркет запланировал к отгрузке. format: int32
plannedCount (optional)
Integer Количество заказов, которое Маркет подтвердил к отгрузке. format: int32
factCount (optional)
Integer Количество заказов, принятых в сортировочном центре или пункте приема. format: int32
status (optional)
statusDescription (optional)
String Описание статуса отгрузки.
statusUpdateTime (optional)
Date Время последнего изменения статуса отгрузки. format: date-time
Формат страницы:
A4 — формат страницы A4.A8 — формат страницы A8.
Статус отгрузки.
status (optional)
description (optional)
String Описание статуса отгрузки.
updateTime (optional)
Date Время последнего изменения статуса отгрузки. format: date-time
Статус отгрузки:
OUTBOUND_CREATED — формируется.OUTBOUND_READY_FOR_CONFIRMATION — можно обрабатывать.OUTBOUND_CONFIRMED — подтверждена и готова к отправке.OUTBOUND_SIGNED — по ней подписан электронный акт приема-передачи.ACCEPTED — принята в сортировочном центре или пункте приема.ACCEPTED_WITH_DISCREPANCIES — принята с расхождениями.FINISHED — завершена.ERROR — отменена из-за ошибки.
Способ отгрузки заказов:
IMPORT — вы самостоятельно привозите заказы в выбранный сортировочный центр или пункт приема заказов.WITHDRAW — вы отгружаете заказы со своего склада курьерам Яндекс Маркета.
Группировка данных отчета.
Возможные значения:
CATEGORIES — группировка по категориям.OFFERS — группировка по товарам.
Идентификаторы отзывов.
feedbackIds
set[Long] Список идентификаторов отзывов, на которые магазин не будет отвечать. format: int64
Список товаров и ставок на них.
sku
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
bid
Integer Значение ставки. format: int32
Список товаров с рекомендованными ставками.
sku
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
bid
Integer Значение ставки. format: int32
bidRecommendations (optional)
array[BidRecommendationItemDTO] Список рекомендованных ставок с соответствующими долями показов. Чем больше ставка, тем большую долю показов она помогает получить.
priceRecommendations (optional)
Направление сортировки.
Возможные значения:
ASC — сортировка по возрастанию.DESC — сортировка по убыванию.
Товар, для которого требуется получить цены для продвижения.
offerId (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
marketSku (optional)
Long SKU на Маркете. format: int64
Запрос на получение списка цен для продвижения.
Ответ на запрос списка цен для продвижения.
status (optional)
result (optional)
Результат запроса цен для продвижения.
Информация о товаре.
offerId (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
name (optional)
String Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке.
Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей.
Оптимальная длина — 50–60 символов, максимальная — 256.
Рекомендации и правила
category (optional)
String Категория товара в вашем магазине. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.
Указывайте конкретные категории — например, набор ножей лучше отнести к категории Столовые приборы, а не просто Посуда.
Выбирайте категории, которые описывают товар, а не абстрактный признак — например, Духи, а не Подарки.
Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.
vendor (optional)
String Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.
barcodes (optional)
array[String] Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128.
Для книг указывайте ISBN.
Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN.
Что такое GTIN
description (optional)
String Подробное описание товара: например, его преимущества и особенности.
Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок.
Можно использовать теги:
- <h>, <h1>, <h2> и так далее — для заголовков;
- <br> и <p> — для переноса строки;
- <ol> — для нумерованного списка;
- <ul> — для маркированного списка;
- <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>);
- <div> — поддерживается, но не влияет на отображение текста.
Оптимальная длина — 400–600 символов, максимальная — 6000.
Рекомендации и правила
vendorCode (optional)
String Артикул товара от производителя.
basicPrice (optional)
Товар с соответствующей карточкой на Маркете.
offer (optional)
mapping (optional)
Информация о тарифах, по которым нужно заплатить за услуги Маркета.
type
percent (optional)
BigDecimal {% note warning "" %}
Этот параметр устарел. Не используйте его.
{% endnote %}
Значение тарифа в процентах.
amount
parameters
Детали расчета конкретной услуги Маркета.
Услуга Маркета или дополнительный тариф к услуге размещения:
-
AGENCY_COMMISSION — прием платежа покупателя.
-
PAYMENT_TRANSFER — перевод платежа покупателя.
-
STORAGE — хранение товара на складе Маркета в течение суток.
-
SURPLUS — хранение излишков на складе Маркета.
-
WITHDRAW — вывоз товара со склада Маркета.
-
FEE — размещение товара на Маркете.
-
DELIVERY_TO_CUSTOMER — доставка покупателю.
-
CROSSREGIONAL_DELIVERY — доставка в федеральный округ, город или населенный пункт.
-
CROSSREGIONAL_DELIVERY_RETURN — доставка невыкупов и возвратов.
-
DISPOSAL — утилизация.
-
SORTING_CENTER_STORAGE — хранение невыкупов и возвратов.
-
EXPRESS_DELIVERY — экспресс-доставка покупателю.
-
FF_XDOC_SUPPLY_BOX — поставка товара через транзитный склад (за короб).
-
FF_XDOC_SUPPLY_PALLET — поставка товара через транзитный склад (за палету).
-
SORTING — обработка заказа.
-
MIDDLE_MILE — средняя миля.
-
RETURN_PROCESSING — обработка невыкупов и возвратов.
-
EXPRESS_CANCELLED_BY_PARTNER — отмена заказа с экспресс-доставкой.
-
DELIVERY_TO_CUSTOMER_RETURN — возврат доставляемого товара на склад.
-
CROSSBORDER_DELIVERY — доставка из-за рубежа.
-
INTAKE_SORTING_BULKY_CARGO — сортировка заказов с крупногабаритными товарами, которые Маркет забрал со склада продавца.
-
INTAKE_SORTING_SMALL_GOODS — сортировка заказов с малогабаритными товарами, которые Маркет забрал со склада продавца.
-
INTAKE_SORTING_DAILY — организация забора заказов со склада продавца.
-
FF_STORAGE_BILLING — хранения товаров на складе.
-
CANCELLED_ORDER_FEE_QI — отмена заказа по вине продавца.
-
LATE_ORDER_EXECUTION_FEE_QI — несвоевременная отгрузка или доставка.
Подробнее об услугах Маркета читайте в Справке Маркета для продавцов.
Временной отрезок с комментарием. Требования к содержанию комментария зависят от контекста использования параметра и указаны в описании поля, которое его содержит.
timePeriod
Integer Продолжительность в указанных единицах.
timeUnit
comment (optional)
Единица измерения времени:
HOUR — час.DAY — сутки.WEEK — неделя.MONTH — месяц.YEAR — год.
Информация о трек-номерах.
trackCode (optional)
String Трек-код почтового отправления.
Запрос переноса заказов из отгрузки.
orderIds
array[Long] Список заказов, которые вы не успеваете подготовить. format: int64
Информация об оборачиваемости товара.
turnover
turnoverDays (optional)
Оценка оборачиваемости.
|enum|Диапазон оборачиваемости|Комментарий|
|-|-|-|
|LOW|turnoverDays ≥ 120||
|ALMOST_LOW|100 ≤ turnoverDays < 120||
|HIGH|45 ≤ turnoverDays < 100||
|VERY_HIGH|0 ≤ turnoverDays < 45||
|NO_SALES|—|Продаж нет.|
|FREE_STORE|Любое значение.|Товары этой категории сейчас хранятся бесплатно.|
Единица измерения.
id
Long Идентификатор единицы измерения. format: int64
name
String Сокращенное название единицы измерения.
fullName
String Полное название единицы измерения.
Товар с новой ценой.
offerId
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
price
Запрос на установку базовых цен на товары.
Параметры размещения товара в магазине.
offerId
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
quantum (optional)
available (optional)
vat (optional)
Integer Ставка НДС, применяемая для товара. Задается цифрой:
2 — 10%.5 — 0%.6 — не облагается НДС.7 — 20%.
Если параметр не указан, используется ставка НДС, установленная в кабинете продавца на Маркете.
format: int32
Запрос на обновление предложений товаров магазина.
Комментарий к отзыву или другому комментарию.
id (optional)
Long Идентификатор комментария к отзыву. format: int64
parentId (optional)
Long Идентификатор комментария к отзыву. format: int64
text
Комментарий к отзыву.
feedbackId
Long Идентификатор отзыва. format: int64
comment
status (optional)
result (optional)
Карточка на Маркете, которая, с вашей точки зрения, подходит товару. Чтобы определить идентификатор подходящей карточки, воспользуйтесь поиском в кабинете (Товары → Каталог → Загрузить товары).
По результатам проверки Маркет может привязать товар к более подходящей карточке.
marketSku (optional)
Long SKU на Маркете. format: int64
Информация о товарах в каталоге.
name (optional)
String Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке.
Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей.
Оптимальная длина — 50–60 символов, максимальная — 256.
Рекомендации и правила
shopSku (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
category (optional)
String Категория товара в вашем магазине. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.
Указывайте конкретные категории — например, набор ножей лучше отнести к категории Столовые приборы, а не просто Посуда.
Выбирайте категории, которые описывают товар, а не абстрактный признак — например, Духи, а не Подарки.
Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.
vendor (optional)
String Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.
vendorCode (optional)
String Артикул товара от производителя.
description (optional)
String Подробное описание товара: например, его преимущества и особенности.
Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок.
Можно использовать теги:
- <h>, <h1>, <h2> и так далее — для заголовков;
- <br> и <p> — для переноса строки;
- <ol> — для нумерованного списка;
- <ul> — для маркированного списка;
- <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>);
- <div> — поддерживается, но не влияет на отображение текста.
Оптимальная длина — 400–600 символов, максимальная — 6000.
Рекомендации и правила
id (optional)
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
feedId (optional)
Long Идентификатор фида. format: int64
barcodes (optional)
array[String] Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128.
Для книг указывайте ISBN.
Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN.
Что такое GTIN
urls (optional)
array[String] URL фотографии товара или страницы с описанием на вашем сайте.
Переданные данные не будут отображаться на витрине, но они помогут специалистам Маркета найти карточку для вашего товара.
Должен содержать один вложенный параметр url.
pictures (optional)
array[String] Ссылки (URL) изображений товара в хорошем качестве.
Можно указать до 30 ссылок. При этом изображение по первой ссылке будет основным. Оно используется в качестве изображения товара в поиске Маркета и на карточке товара. Другие изображения товара доступны в режиме просмотра увеличенных изображений.
Обязательный параметр.
Должен содержать хотя бы один вложенный параметр picture.
manufacturer (optional)
String Изготовитель товара: компания, которая произвела товар, ее адрес и регистрационный номер (если есть).
Необязательный параметр.
manufacturerCountries (optional)
array[String] Список стран, в которых произведен товар.
Обязательный параметр.
Должен содержать хотя бы одну, но не больше 5 стран.
minShipment (optional)
Integer Минимальное количество единиц товара, которое вы поставляете на склад.
Например, если вы поставляете детское питание партиями минимум по 10 коробок, а в каждой коробке по 6 баночек, укажите значение 60.
format: int32
transportUnitSize (optional)
Integer Количество единиц товара в одной упаковке, которую вы поставляете на склад.
Например, если вы поставляете детское питание коробками по 6 баночек, укажите значение 6.
format: int32
quantumOfSupply (optional)
Integer Добавочная партия: по сколько единиц товара можно добавлять к минимальному количеству minShipment.
Например, если вы поставляете детское питание партиями минимум по 10 коробок и хотите добавлять к минимальной партии по 2 коробки, а в каждой коробке по 6 баночек, укажите значение 12.
format: int32
deliveryDurationDays (optional)
Integer Срок, за который продавец поставляет товары на склад, в днях. format: int32
boxCount (optional)
Integer Сколько мест (если больше одного) занимает товар.
Параметр указывается, только если товар занимает больше одного места (например, кондиционер занимает два места: внешний и внутренний блоки в двух коробках). Если товар занимает одно место, не указывайте этот параметр.
format: int32
customsCommodityCodes (optional)
array[String] Список кодов товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД).
Обязательный параметр, если товар подлежит особому учету (например, в системе «Меркурий» как продукция животного происхождения или в системе «Честный ЗНАК»).
Может содержать только один вложенный код ТН ВЭД.
weightDimensions (optional)
supplyScheduleDays (optional)
shelfLifeDays (optional)
Integer {% note warning "" %}
Этот параметр устарел. Вместо него используйте shelfLife. Совместное использование обоих параметров приведет к ошибке.
{% endnote %}
Срок годности: через сколько дней товар станет непригоден для использования.
format: int32
lifeTimeDays (optional)
Integer {% note warning "" %}
Этот параметр устарел. Вместо него используйте lifeTime. Совместное использование обоих параметров приведет к ошибке.
{% endnote %}
Срок службы: сколько дней товар будет исправно выполнять свою функцию, а изготовитель — нести ответственность за его существенные недостатки.
format: int32
guaranteePeriodDays (optional)
Integer Гарантийный срок товара: сколько дней возможно обслуживание и ремонт товара или возврат денег, а изготовитель или продавец будет нести ответственность за недостатки товара. format: int32
processingState (optional)
availability (optional)
shelfLife (optional)
lifeTime (optional)
guaranteePeriod (optional)
certificate (optional)
String Номер документа на товар.
Перед указанием номера документ нужно загрузить в кабинете продавца на Маркете. Инструкция
Запрос на установку новых значений для параметров.
Описывает проблемы, которые появились при сохранении товара.
status (optional)
results (optional)
array[UpdateOfferContentResultDTO] Ошибки и предупреждения, которые появились при обработке переданных значений. Каждый элемент списка соответствует одному товару.
Если ошибок и предупреждений нет, поле не передается.
Ошибки и предупреждения, которые появились из-за переданных характеристик.
offerId
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
errors (optional)
warnings (optional)
Параметры товара.
offerId
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
name (optional)
String Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке.
Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей.
Оптимальная длина — 50–60 символов, максимальная — 256.
Рекомендации и правила
marketCategoryId (optional)
Long Идентификатор категории на Маркете, к которой вы относите свой товар.
Если не указать marketCategoryId, то маркетная категория будет определена автоматически.
При изменении информации о товаре передавайте тот же идентификатор категории. Если вы укажете другой, категория товара не поменяется. Изменить ее можно только в кабинете продавца на Маркете.
Список категорий Маркета можно получить с помощью запроса POST categories/tree.
format: int64
category (optional)
String Категория товара в вашем магазине. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.
Указывайте конкретные категории — например, набор ножей лучше отнести к категории Столовые приборы, а не просто Посуда.
Выбирайте категории, которые описывают товар, а не абстрактный признак — например, Духи, а не Подарки.
Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.
pictures (optional)
array[String] Ссылки на изображения товара. Изображение по первой ссылке считается основным, остальные дополнительными.
Требования к ссылкам
- Ссылок может быть до 30.
- Указывайте ссылку целиком, включая протокол http или https.
- Максимальная длина — 512 символов.
- Русские буквы в URL можно.
- Можно использовать прямые ссылки на изображения и на Яндекс Диск. Ссылки на Яндекс Диске нужно копировать с помощью функции Поделиться. Относительные ссылки и ссылки на другие облачные хранилища — не работают.
✅ https://example-shop.ru/images/sku12345.jpg
✅ https://yadi.sk/i/NaBoRsimVOLov
❌ /images/sku12345.jpg
❌ https://www.dropbox.com/s/818f/tovar.jpg
Ссылки на изображение должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке.
Если нужно заменить изображение, выложите новое изображение по новой ссылке, а ссылку на старое удалите. Если просто заменить изображение по старой ссылке, оно не обновится.
Требования к изображениям
videos (optional)
array[String] Ссылка (URL) на видео товара.
Максимальное количество ссылок — 6.
Требования к ссылке
- Указывайте ссылку целиком, включая протокол http или https.
- Максимальная длина — 512 символов.
- Русские буквы в URL можно.
- Можно использовать прямые ссылки на видео и на Яндекс Диск. Ссылки на Яндекс Диске нужно копировать с помощью функции Поделиться. Относительные ссылки и ссылки на другие облачные хранилища — не работают.
✅ https://example-shop.ru/video/sku12345.avi
✅ https://yadi.sk/i/NaBoRsimVOLov
❌ /video/sku12345.avi
❌ https://www.dropbox.com/s/818f/super-tovar.avi
Ссылки на видео должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке.
Если нужно заменить видео, выложите новое видео по новой ссылке, а ссылку на старое удалите. Если просто заменить видео по старой ссылке, оно не обновится.
Требования к видео
manuals (optional)
array[OfferManualDTO] Список инструкций по использованию товара.
Максимальное количество инструкций — 6.
Если вы передадите пустое поле manuals, загруженные ранее инструкции удалятся.
vendor (optional)
String Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.
barcodes (optional)
array[String] Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128.
Для книг указывайте ISBN.
Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN.
Что такое GTIN
description (optional)
String Подробное описание товара: например, его преимущества и особенности.
Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок.
Можно использовать теги:
- <h>, <h1>, <h2> и так далее — для заголовков;
- <br> и <p> — для переноса строки;
- <ol> — для нумерованного списка;
- <ul> — для маркированного списка;
- <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>);
- <div> — поддерживается, но не влияет на отображение текста.
Оптимальная длина — 400–600 символов, максимальная — 6000.
Рекомендации и правила
manufacturerCountries (optional)
array[String] Страна, где был произведен товар.
Записывайте названия стран так, как они записаны в списке.
weightDimensions (optional)
vendorCode (optional)
String Артикул товара от производителя.
tags (optional)
array[String] Метки товара, используемые магазином. Покупателям теги не видны. По тегам можно группировать и фильтровать разные товары в каталоге — например, товары одной серии, коллекции или линейки.
Максимальная длина тега 20 символов. У одного товара может быть максимум 10 тегов. Всего можно создать не больше 50 разных тегов.
shelfLife (optional)
lifeTime (optional)
guaranteePeriod (optional)
customsCommodityCode (optional)
String Код товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД) — 10 или 14 цифр без пробелов.
Обязательно укажите, если он есть.
certificates (optional)
array[String] Номера документов на товар: сертификата, декларации соответствия и т. п.
Передавать можно только номера документов, сканы которого загружены в кабинете продавца по инструкции.
boxCount (optional)
Integer Количество грузовых мест.
Параметр используется, если товар представляет собой несколько коробок, упаковок и так далее. Например, кондиционер занимает два места — внешний и внутренний блоки в двух коробках.
Для товаров, занимающих одно место, не передавайте этот параметр.
format: int32
condition (optional)
type (optional)
downloadable (optional)
adult (optional)
Boolean Параметр включает для товара пометку 18+. Устанавливайте ее только для товаров, которые относятся к удовлетворению сексуальных потребностей.
age (optional)
params (optional)
array[OfferParamDTO] {% note warning "" %}
Этот параметр устарел. При передаче характеристик используйте parameterValues.
{% endnote %}
Характеристики, которые есть только у товаров конкретной категории — например, диаметр колес велосипеда или материал подошвы обуви.
parameterValues (optional)
array[ParameterValueDTO] Список характеристик с их значениями.
С parameterValues обязательно передавайте marketCategoryId — идентификатор категории на Маркете, к которой относятся указанные характеристики товара.
При изменении характеристик передавайте только те, значение которых нужно обновить.
Чтобы удалить значение заданной характеристики, передайте ее parameterId с пустым value.
Максимальное количество характеристик — 300.
basicPrice (optional)
purchasePrice (optional)
additionalExpenses (optional)
cofinancePrice (optional)
Список товаров.
В теле запроса можно передать от одного до 500 товаров.
Обязательный параметр.
mapping (optional)
awaitingModerationMapping (optional)
rejectedMapping (optional)
offer (optional)
Запрос на обновление товаров.
Ошибки и предупреждения, которые появились из-за переданных характеристик.
offerId
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
errors (optional)
warnings (optional)
offerMappings
onlyPartnerMediaContent (optional)
Boolean Будут использоваться только переданные вами изображения товаров.
Значение по умолчанию — false. Если вы хотите заменить изображения, которые добавил Маркет, передайте значение true.
Описывает проблемы, возникшие при сохранении товара.
status (optional)
results (optional)
array[UpdateOfferMappingResultDTO] Ошибки и предупреждения, которые появились при обработке списка характеристик. Каждый элемент списка соответствует одному товару.
Если ошибок и предупреждений нет, поле не передается.
Запрос на обновление состава заказа.
items
array[OrderItemModificationDTO] Список товаров в заказе.
Если магазин не передал информацию о товаре во входных данных, он будет удален из заказа.
Обязательный параметр.
reason (optional)
Список заказов.
id (optional)
Long Идентификатор заказа. format: int64
status (optional)
substatus (optional)
updateStatus (optional)
errorDetails (optional)
String Ошибка при изменении статуса заказа. Содержит описание ошибки и идентификатор заказа.
Возвращается, если параметр updateStatus принимает значение ERROR.
Информация об изменении статуса заказа.
Список заказов, статус которых обновился.
status (optional)
result (optional)
Запрос на обновление срока хранения заказа в ПВЗ.
newDate
date Новая дата, до которой заказ будет храниться в пункте выдачи.
Срок хранения можно увеличить не больше, чем на 30 дней.
Формат даты: ГГГГ-ММ-ДД.
format: date
Запрос на создание или изменение лицензий для точек продаж.
licenses
array[OutletLicenseDTO] Список лицензий.
Обязательный параметр, должен содержать информацию хотя бы об одной лицензии.
Цена с указанием скидки.
value
currencyId
discountBase (optional)
BigDecimal Цена до скидки.
Число должно быть целым. Вы можете указать цену со скидкой от 5 до 99%.
Передавайте этот параметр при каждом обновлении цены, если предоставляете скидку на товар.
Запрос на установку цен на товары.
Описание товаров, которые участвуют в акции.
offerId
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
params (optional)
Параметры товара в акции с типом DIRECT_DISCOUNT или BLUE_FLASH.
Обязательный параметр для акций с этими типами.
price (optional)
Long Зачеркнутая цена — та, по которой товар продавался до акции.
Указывается в рублях.
Число должно быть целым.
format: int64
promoPrice (optional)
Long Цена по акции — та, по которой вы хотите продавать товар.
Указывается в рублях.
Число должно быть целым.
format: int64
Параметры товара, который участвует в акции.
discountParams (optional)
Добавление товаров в акцию или обновление их параметров.
Чтобы добавить товары в акцию или обновить параметры каких-то товаров, передайте их в параметре offers.
Результат добавления товаров в акцию.
status (optional)
result (optional)
Ошибки и предупреждения, которые появились при добавлении товаров в акцию.
rejectedOffers (optional)
warningOffers (optional)
array[WarningPromoOfferUpdateDTO] Изменения, по которым есть предупреждения. Они информируют о возможных проблемах. Информация о товарах обновится.
Возвращается, только если есть предупреждения.
Информация об остатках одного товара на одном из складов.
sku
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
items
Информация об остатках товара.
count
Long Количество доступного товара. format: int64
updatedAt (optional)
Date Дата и время последнего обновления информации об остатках.
Если вы не передали параметр
updatedAt, используется текущее время.
Формат даты и времени: ISO 8601 со смещением относительно UTC. Например,
2017-11-21T00:42:42+03:00. format: date-time
Запрос на изменение информации по остаткам товаров.
Время последнего обновления.
updatedAt
Date Время последнего обновления. format: date-time
Ограничение на возможные значения, накладываемое другой характеристикой.
Если ограничивающая характеристика принимает определенное значение, список возможных значений ограничиваемой характеристики сокращается.
Пример
Характеристика размер сама по себе может принимать девять разных значений: S, M, L, 44, 46, 48, 42/164, 46/176, 44S.
Если ограничивающая характеристика размерная сетка принимает значение RU, список возможных значений размера сокращается до 44, 46, 48.
limitingParameterId
Long Идентификатор ограничивающей характеристики. format: int64
limitedValues
code (optional)
String Код для подтверждения ЭАПП.
status (optional)
result (optional)
Адрес склада.
city
street (optional)
number (optional)
building (optional)
block (optional)
gps
Информация о складе.
id
Long Идентификатор склада. format: int64
name
campaignId
Long Идентификатор кампании в API и идентификатор магазина. format: int64
express
Boolean Возможна ли доставка по модели Экспресс.
address (optional)
Информация о группе складов.
name
String Название группы складов.
mainWarehouse
warehouses
Информация об остатках товара.
offerId
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
turnoverSummary (optional)
stocks
updatedAt (optional)
Date Дата и время последнего обновления информации об остатках.
Формат даты и времени: ISO 8601 со смещением относительно UTC. Например, 2023-11-21T00:42:42+03:00.
format: date-time
Информация об остатках товаров на складе.
warehouseId
Long Идентификатор склада. format: int64
offers
Информация об остатках товара.
type
count
Long Значение остатков. format: int64
Тип остатков товаров на складе:
-
AVAILABLE (соответствует типу «Доступный к заказу» в отчете «Остатки на складе» в кабинете продавца на Маркете) — товар, доступный для продажи.
-
DEFECT (соответствует типу «Брак») — товар с браком.
-
EXPIRED (соответствует типу «Просрочен») — товар с истекшим сроком годности.
-
FIT (соответствует типу «Годный») — товар, который доступен для продажи или уже зарезервирован.
-
FREEZE — товар, который зарезервирован для заказов.
-
QUARANTINE (соответствует типу «Карантин») — товар, временно недоступный для продажи (например, товар перемещают из одного помещения склада в другое).
-
UTILIZATION — товар, который будет утилизирован.
Информация о складах и группах складов.
warehouses
warehouseGroups
Описание предупреждения, которое появилось при добавлении товара.
offerId
String Ваш SKU — идентификатор товара в вашей системе.
Разрешена любая последовательность длиной до 255 знаков.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
Что такое SKU и как его назначать
warnings